Package com.azure.resourcemanager.apimanagement.models

Interface IdentityProviders

public interface IdentityProviders
Resource collection API of IdentityProviders.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<IdentityProviderContract> listByService(String resourceGroupName, String serviceName)
      Lists a collection of Identity Provider configured in the specified service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      Returns:
      list of all the Identity Providers configured on the service instance as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByService

      com.azure.core.http.rest.PagedIterable<IdentityProviderContract> listByService(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
      Lists a collection of Identity Provider configured in the specified service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      context - The context to associate with this operation.
      Returns:
      list of all the Identity Providers configured on the service instance as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTagWithResponse

      IdentityProvidersGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the identityProvider specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      context - The context to associate with this operation.
      Returns:
      the entity state (Etag) version of the identityProvider specified by its identifier.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName)
      Gets the entity state (Etag) version of the identityProvider specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<IdentityProviderContract> getWithResponse(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, com.azure.core.util.Context context)
      Gets the configuration details of the identity Provider configured in specified service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      context - The context to associate with this operation.
      Returns:
      the configuration details of the identity Provider configured in specified service instance.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      IdentityProviderContract get(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName)
      Gets the configuration details of the identity Provider configured in specified service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      Returns:
      the configuration details of the identity Provider configured in specified service instance.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified identity provider configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, String ifMatch)
      Deletes the specified identity provider configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSecretsWithResponse

      com.azure.core.http.rest.Response<ClientSecretContract> listSecretsWithResponse(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, com.azure.core.util.Context context)
      Gets the client secret details of the Identity Provider.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      context - The context to associate with this operation.
      Returns:
      the client secret details of the Identity Provider.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSecrets

      ClientSecretContract listSecrets(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName)
      Gets the client secret details of the Identity Provider.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      identityProviderName - Identity Provider Type identifier.
      Returns:
      the client secret details of the Identity Provider.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      IdentityProviderContract getById(String id)
      Gets the configuration details of the identity Provider configured in specified service instance.
      Parameters:
      id - the resource ID.
      Returns:
      the configuration details of the identity Provider configured in specified service instance.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<IdentityProviderContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the configuration details of the identity Provider configured in specified service instance.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the configuration details of the identity Provider configured in specified service instance.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Deletes the specified identity provider configuration.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified identity provider configuration.
      Parameters:
      id - the resource ID.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      IdentityProviderContract.DefinitionStages.Blank define(IdentityProviderType name)
      Begins definition for a new IdentityProviderContract resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new IdentityProviderContract definition.