Package org.azd.graph.serviceprincipals

Class ServicePrincipalsRequestBuilder

java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.graph.serviceprincipals.ServicePrincipalsRequestBuilder
public class ServicePrincipalsRequestBuilder extends BaseRequestBuilder
Provides functionality to work with Graph Service Principals Api.

  • Constructor Details

    • ServicePrincipalsRequestBuilder

      public ServicePrincipalsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)
      Instantiates a new RequestBuilder instance and sets the default values.
      Parameters:
      organizationUrl - Represents organization location request url.
      accessTokenCredential - Access token credential object.

  • Method Details

    • createAsync

      public CompletableFuture<GraphServicePrincipal> createAsync(GraphServicePrincipalCreationContext creationContext) throws AzDException
      Materialize an existing AAD service principal into the ADO account.

      NOTE: Created service principals are not active in an account.

      Adding a service principal to an account is required before the service principal can be added to ADO groups or assigned an asset.

      The body of the request must be a derived type of GraphServicePrincipalCreationContext:

      GraphServicePrincipalOriginIdCreationContext - Create a new service principal using the OriginID as a reference to an existing service principal from AAD backed provider.

      If the service principal to be added corresponds to a service principal that was previously deleted, then that service principal will be restored.

      Optionally, you can add the newly created service principal as a member of an existing ADO group and/or specify a custom storage key for the service principal.
      Parameters:
      creationContext - Graph origin id creation context. Pass the origin id to create service principal.
      Returns:
      Graph Service Principal object GraphServicePrincipal
      Throws:
      AzDException - Default Api exception handler.

    • createAsync

      public CompletableFuture<GraphServicePrincipal> createAsync(GraphServicePrincipalCreationContext creationContext, Consumer<ServicePrincipalsRequestBuilder.RequestConfiguration> requestConfiguration) throws AzDException
      Materialize an existing AAD service principal into the ADO account.

      NOTE: Created service principals are not active in an account.

      Adding a service principal to an account is required before the service principal can be added to ADO groups or assigned an asset.

      The body of the request must be a derived type of GraphServicePrincipalCreationContext:

      GraphServicePrincipalOriginIdCreationContext - Create a new service principal using the OriginID as a reference to an existing service principal from AAD backed provider.

      If the service principal to be added corresponds to a service principal that was previously deleted, then that service principal will be restored.

      Optionally, you can add the newly created service principal as a member of an existing ADO group and/or specify a custom storage key for the service principal.
      Parameters:
      creationContext - Graph origin id creation context. Pass the origin id to create service principal.
      requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.
      Returns:
      Graph Service Principal object GraphServicePrincipal
      Throws:
      AzDException - Default Api exception handler.

    • deleteAsync

      public CompletableFuture<Void> deleteAsync(String servicePrincipalDescriptor) throws AzDException
      Disables a service principal. The service principal will still be visible, but membership checks for the service principal will return false.
      Parameters:
      servicePrincipalDescriptor - The descriptor of the service principal to delete.
      Throws:
      AzDException - Default Api exception handler.

    • getAsync

      public CompletableFuture<GraphServicePrincipal> getAsync(String servicePrincipalDescriptor) throws AzDException
      Get a service principal by its descriptor.
      Parameters:
      servicePrincipalDescriptor - The descriptor of the service principal to delete.
      Returns:
      Graph Service Principal object GraphServicePrincipal
      Throws:
      AzDException - Default Api exception handler.

    • listAsync

      public CompletableFuture<GraphServicePrincipals> listAsync() throws AzDException
      Get a list of all service principals in a given scope. Since the list of service principals may be large, results are returned in pages of service principals. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results. The only reliable way to know if there is no more service principals left is the lack of a continuation token.
      Returns:
      Collection of graph service principals.
      Throws:
      AzDException - Default Api exception handler.

    • listAsync

      public CompletableFuture<GraphServicePrincipals> listAsync(Consumer<ServicePrincipalsRequestBuilder.ListRequestConfiguration> requestConfiguration) throws AzDException
      Get a list of all service principals in a given scope. Since the list of service principals may be large, results are returned in pages of service principals. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results. The only reliable way to know if there is no more service principals left is the lack of a continuation token.
      Parameters:
      requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.
      Returns:
      Collection of graph service principals.
      Throws:
      AzDException - Default Api exception handler.

    • create

      public GraphServicePrincipal create(GraphServicePrincipalOriginIdCreationContext creationContext) throws AzDException
      Materialize an existing AAD service principal into the ADO account.

      NOTE: Created service principals are not active in an account.

      Adding a service principal to an account is required before the service principal can be added to ADO groups or assigned an asset.

      The body of the request must be a derived type of GraphServicePrincipalCreationContext:

      GraphServicePrincipalOriginIdCreationContext - Create a new service principal using the OriginID as a reference to an existing service principal from AAD backed provider.

      If the service principal to be added corresponds to a service principal that was previously deleted, then that service principal will be restored.

      Optionally, you can add the newly created service principal as a member of an existing ADO group and/or specify a custom storage key for the service principal.
      Parameters:
      creationContext - Graph origin id creation context. Pass the origin id to create service principal.
      Returns:
      Graph Service Principal object GraphServicePrincipal
      Throws:
      AzDException - Default Api exception handler.

    • create

      public GraphServicePrincipal create(GraphServicePrincipalOriginIdCreationContext creationContext, Consumer<ServicePrincipalsRequestBuilder.RequestConfiguration> requestConfiguration) throws AzDException
      Materialize an existing AAD service principal into the ADO account.

      NOTE: Created service principals are not active in an account.

      Adding a service principal to an account is required before the service principal can be added to ADO groups or assigned an asset.

      The body of the request must be a derived type of GraphServicePrincipalCreationContext:

      GraphServicePrincipalOriginIdCreationContext - Create a new service principal using the OriginID as a reference to an existing service principal from AAD backed provider.

      If the service principal to be added corresponds to a service principal that was previously deleted, then that service principal will be restored.

      Optionally, you can add the newly created service principal as a member of an existing ADO group and/or specify a custom storage key for the service principal.
      Parameters:
      creationContext - Graph origin id creation context. Pass the origin id to create service principal.
      requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.
      Returns:
      Graph Service Principal object GraphServicePrincipal
      Throws:
      AzDException - Default Api exception handler.

    • delete

      public Void delete(String servicePrincipalDescriptor) throws AzDException
      Disables a service principal. The service principal will still be visible, but membership checks for the service principal will return false.
      Parameters:
      servicePrincipalDescriptor - The descriptor of the service principal to delete.
      Throws:
      AzDException - Default Api exception handler.

    • get

      public GraphServicePrincipal get(String servicePrincipalDescriptor) throws AzDException
      Get a service principal by its descriptor.
      Parameters:
      servicePrincipalDescriptor - The descriptor of the service principal to delete.
      Returns:
      Graph Service Principal object GraphServicePrincipal
      Throws:
      AzDException - Default Api exception handler.

    • list

      public GraphServicePrincipals list() throws AzDException
      Get a list of all service principals in a given scope. Since the list of service principals may be large, results are returned in pages of service principals. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results. The only reliable way to know if there is no more service principals left is the lack of a continuation token.
      Returns:
      Collection of graph service principals.
      Throws:
      AzDException - Default Api exception handler.

    • list

      public GraphServicePrincipals list(Consumer<ServicePrincipalsRequestBuilder.ListRequestConfiguration> requestConfiguration) throws AzDException
      Get a list of all service principals in a given scope. Since the list of service principals may be large, results are returned in pages of service principals. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results. The only reliable way to know if there is no more service principals left is the lack of a continuation token.
      Parameters:
      requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.
      Returns:
      Collection of graph service principals.
      Throws:
      AzDException - Default Api exception handler.