OpenIdConnectProvidersClient Interface

public interface OpenIdConnectProvidersClient

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

Method Summary

Modifier and Type Method and Description
abstract OpenidConnectProviderContractInner createOrUpdate(String resourceGroupName, String serviceName, String opid, OpenidConnectProviderContractInner parameters)

Creates or updates the OpenID Connect Provider.

abstract OpenIdConnectProvidersCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String opid, OpenidConnectProviderContractInner parameters, String ifMatch, Context context)

Creates or updates the OpenID Connect Provider.

abstract void delete(String resourceGroupName, String serviceName, String opid, String ifMatch)

Deletes specific OpenID Connect Provider of the API Management service instance.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String opid, String ifMatch, Context context)

Deletes specific OpenID Connect Provider of the API Management service instance.

abstract OpenidConnectProviderContractInner get(String resourceGroupName, String serviceName, String opid)

Gets specific OpenID Connect Provider without secrets.

abstract void getEntityTag(String resourceGroupName, String serviceName, String opid)

Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.

abstract OpenIdConnectProvidersGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String opid, Context context)

Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.

abstract OpenIdConnectProvidersGetResponse getWithResponse(String resourceGroupName, String serviceName, String opid, Context context)

Gets specific OpenID Connect Provider without secrets.

abstract PagedIterable<OpenidConnectProviderContractInner> listByService(String resourceGroupName, String serviceName)

Lists of all the OpenId Connect Providers.

abstract PagedIterable<OpenidConnectProviderContractInner> listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists of all the OpenId Connect Providers.

abstract ClientSecretContractInner listSecrets(String resourceGroupName, String serviceName, String opid)

Gets the client secret details of the OpenID Connect Provider.

abstract OpenIdConnectProvidersListSecretsResponse listSecretsWithResponse(String resourceGroupName, String serviceName, String opid, Context context)

Gets the client secret details of the OpenID Connect Provider.

abstract OpenidConnectProviderContractInner update(String resourceGroupName, String serviceName, String opid, String ifMatch, OpenidConnectProviderUpdateContract parameters)

Updates the specific OpenID Connect Provider.

abstract OpenIdConnectProvidersUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, String opid, String ifMatch, OpenidConnectProviderUpdateContract parameters, Context context)

Updates the specific OpenID Connect Provider.

Method Details

createOrUpdate

public abstract OpenidConnectProviderContractInner createOrUpdate(String resourceGroupName, String serviceName, String opid, OpenidConnectProviderContractInner parameters)

Creates or updates the OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
parameters - Create parameters.

Returns:

openId Connect Provider details.

createOrUpdateWithResponse

public abstract OpenIdConnectProvidersCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String opid, OpenidConnectProviderContractInner parameters, String ifMatch, Context context)

Creates or updates the OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
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:

openId Connect Provider details.

delete

public abstract void delete(String resourceGroupName, String serviceName, String opid, String ifMatch)

Deletes specific OpenID Connect Provider of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
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.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String opid, String ifMatch, Context context)

Deletes specific OpenID Connect Provider of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
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:

get

public abstract OpenidConnectProviderContractInner get(String resourceGroupName, String serviceName, String opid)

Gets specific OpenID Connect Provider without secrets.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.

Returns:

specific OpenID Connect Provider without secrets.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String opid)

Gets the entity state (Etag) version of the openIdConnectProvider 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.
opid - Identifier of the OpenID Connect Provider.

getEntityTagWithResponse

public abstract OpenIdConnectProvidersGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String opid, Context context)

Gets the entity state (Etag) version of the openIdConnectProvider 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.
opid - Identifier of the OpenID Connect Provider.
context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the openIdConnectProvider specified by its identifier.

getWithResponse

public abstract OpenIdConnectProvidersGetResponse getWithResponse(String resourceGroupName, String serviceName, String opid, Context context)

Gets specific OpenID Connect Provider without secrets.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
context - The context to associate with this operation.

Returns:

specific OpenID Connect Provider without secrets.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists of all the OpenId Connect Providers.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.

Returns:

paged OpenIdProviders list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists of all the OpenId Connect Providers.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.
top - Number of records to return.
skip - Number of records to skip.
context - The context to associate with this operation.

Returns:

paged OpenIdProviders list representation as paginated response with PagedIterable<T>.

listSecrets

public abstract ClientSecretContractInner listSecrets(String resourceGroupName, String serviceName, String opid)

Gets the client secret details of the OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.

Returns:

the client secret details of the OpenID Connect Provider.

listSecretsWithResponse

public abstract OpenIdConnectProvidersListSecretsResponse listSecretsWithResponse(String resourceGroupName, String serviceName, String opid, Context context)

Gets the client secret details of the OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
context - The context to associate with this operation.

Returns:

the client secret details of the OpenID Connect Provider.

update

public abstract OpenidConnectProviderContractInner update(String resourceGroupName, String serviceName, String opid, String ifMatch, OpenidConnectProviderUpdateContract parameters)

Updates the specific OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
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:

openId Connect Provider details.

updateWithResponse

public abstract OpenIdConnectProvidersUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, String opid, String ifMatch, OpenidConnectProviderUpdateContract parameters, Context context)

Updates the specific OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
opid - Identifier of the OpenID Connect Provider.
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:

openId Connect Provider details.

Applies to