OpenIdConnectProviders Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface OpenIdConnectProviders

Resource collection API of OpenIdConnectProviders.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new OpenidConnectProviderContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String opid, String ifMatch) Deletes specific OpenID Connect Provider of the API Management service instance.
abstract void	deleteById(String id) Deletes specific OpenID Connect Provider of the API Management service instance.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) 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 OpenidConnectProviderContract	get(String resourceGroupName, String serviceName, String opid) Gets specific OpenID Connect Provider without secrets.
abstract OpenidConnectProviderContract	getById(String id) Gets specific OpenID Connect Provider without secrets.
abstract Response<OpenidConnectProviderContract>	getByIdWithResponse(String id, Context context) 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 Response<OpenidConnectProviderContract>	getWithResponse(String resourceGroupName, String serviceName, String opid, Context context) Gets specific OpenID Connect Provider without secrets.
abstract PagedIterable<OpenidConnectProviderContract>	listByService(String resourceGroupName, String serviceName) Lists of all the OpenId Connect Providers.
abstract PagedIterable<OpenidConnectProviderContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists of all the OpenId Connect Providers.
abstract ClientSecretContract	listSecrets(String resourceGroupName, String serviceName, String opid) Gets the client secret details of the OpenID Connect Provider.
abstract Response<ClientSecretContract>	listSecretsWithResponse(String resourceGroupName, String serviceName, String opid, Context context) Gets the client secret details of the OpenID Connect Provider.

Method Details

define

public abstract OpenidConnectProviderContract.DefinitionStages.Blank define(String name)

Begins definition for a new OpenidConnectProviderContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new OpenidConnectProviderContract definition.

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.

deleteById

public abstract void deleteById(String id)

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

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

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

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

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:

the Response<T>.

get

public abstract OpenidConnectProviderContract 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.

getById

public abstract OpenidConnectProviderContract getById(String id)

Gets specific OpenID Connect Provider without secrets.

Parameters:

id - the resource ID.

Returns:

specific OpenID Connect Provider without secrets.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets specific OpenID Connect Provider without secrets.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

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 Response 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 ClientSecretContract 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 Response 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.