Package com.azure.resourcemanager.apimanagement.fluent

Interface IdentityProvidersClient

public interface IdentityProvidersClient

An instance of this class provides access to all the operations defined in IdentityProvidersClient.

Method Summary

Modifier and Type	Method	Description
IdentityProviderContractInner	createOrUpdate(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, IdentityProviderCreateContract parameters)	Creates or Updates the IdentityProvider configuration.
IdentityProvidersCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, IdentityProviderCreateContract parameters, String ifMatch, com.azure.core.util.Context context)	Creates or Updates the IdentityProvider configuration.
void	delete(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, String ifMatch)	Deletes the specified identity provider configuration.
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.
IdentityProviderContractInner	get(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName)	Gets the configuration details of the identity Provider configured in specified service instance.
void	getEntityTag(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName)	Gets the entity state (Etag) version of the identityProvider specified by its identifier.
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.
IdentityProvidersGetResponse	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.
com.azure.core.http.rest.PagedIterable<IdentityProviderContractInner>	listByService(String resourceGroupName, String serviceName)	Lists a collection of Identity Provider configured in the specified service instance.
com.azure.core.http.rest.PagedIterable<IdentityProviderContractInner>	listByService(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Lists a collection of Identity Provider configured in the specified service instance.
ClientSecretContractInner	listSecrets(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName)	Gets the client secret details of the Identity Provider.
IdentityProvidersListSecretsResponse	listSecretsWithResponse(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, com.azure.core.util.Context context)	Gets the client secret details of the Identity Provider.
IdentityProviderContractInner	update(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, String ifMatch, IdentityProviderUpdateParameters parameters)	Updates an existing IdentityProvider configuration.
IdentityProvidersUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, IdentityProviderType identityProviderName, String ifMatch, IdentityProviderUpdateParameters parameters, com.azure.core.util.Context context)	Updates an existing IdentityProvider configuration.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<IdentityProviderContractInner> 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.

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<IdentityProviderContractInner> 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.

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.

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.

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.

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.

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.

get

IdentityProviderContractInner 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.

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.

getWithResponse

IdentityProvidersGetResponse 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.

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.

createOrUpdate

IdentityProviderContractInner createOrUpdate(String resourceGroupName,
                                             String serviceName,
                                             IdentityProviderType identityProviderName,
                                             IdentityProviderCreateContract parameters)

Creates or Updates the IdentityProvider configuration.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

identityProviderName - Identity Provider Type identifier.

parameters - Create parameters.

Returns:

identity Provider details.

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.

createOrUpdateWithResponse

IdentityProvidersCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                                   String serviceName,
                                                                   IdentityProviderType identityProviderName,
                                                                   IdentityProviderCreateContract parameters,
                                                                   String ifMatch,
                                                                   com.azure.core.util.Context context)

Creates or Updates the IdentityProvider configuration.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

identityProviderName - Identity Provider Type identifier.

parameters - Create parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

identity Provider details.

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.

update

IdentityProviderContractInner update(String resourceGroupName,
                                     String serviceName,
                                     IdentityProviderType identityProviderName,
                                     String ifMatch,
                                     IdentityProviderUpdateParameters parameters)

Updates an existing IdentityProvider configuration.

Parameters:

resourceGroupName - The name of the resource group.

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.

parameters - Update parameters.

Returns:

identity Provider details.

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.

updateWithResponse

IdentityProvidersUpdateResponse updateWithResponse(String resourceGroupName,
                                                   String serviceName,
                                                   IdentityProviderType identityProviderName,
                                                   String ifMatch,
                                                   IdentityProviderUpdateParameters parameters,
                                                   com.azure.core.util.Context context)

Updates an existing IdentityProvider configuration.

Parameters:

resourceGroupName - The name of the resource group.

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.

parameters - Update parameters.

context - The context to associate with this operation.

Returns:

identity Provider details.

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.

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.

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.

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.

listSecrets

ClientSecretContractInner listSecrets(String resourceGroupName,
                                      String serviceName,
                                      IdentityProviderType identityProviderName)

Gets the client secret details of the Identity Provider.

Parameters:

resourceGroupName - The name of the resource group.

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.

listSecretsWithResponse

IdentityProvidersListSecretsResponse 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.

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.