Package com.azure.resourcemanager.apimanagement.models

Interface OpenIdConnectProviders

public interface OpenIdConnectProviders

Resource collection API of OpenIdConnectProviders.

Method Summary

Modifier and Type	Method	Description
OpenidConnectProviderContract.DefinitionStages.Blank	define(String name)	Begins definition for a new OpenidConnectProviderContract resource.
void	delete(String resourceGroupName, String serviceName, String opid, String ifMatch)	Deletes specific OpenID Connect Provider of the API Management service instance.
void	deleteById(String id)	Deletes specific OpenID Connect Provider of the API Management service instance.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	Deletes specific OpenID Connect Provider of the API Management service instance.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String opid, String ifMatch, com.azure.core.util.Context context)	Deletes specific OpenID Connect Provider of the API Management service instance.
OpenidConnectProviderContract	get(String resourceGroupName, String serviceName, String opid)	Gets specific OpenID Connect Provider without secrets.
OpenidConnectProviderContract	getById(String id)	Gets specific OpenID Connect Provider without secrets.
com.azure.core.http.rest.Response<OpenidConnectProviderContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets specific OpenID Connect Provider without secrets.
void	getEntityTag(String resourceGroupName, String serviceName, String opid)	Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.
OpenIdConnectProvidersGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String opid, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.
com.azure.core.http.rest.Response<OpenidConnectProviderContract>	getWithResponse(String resourceGroupName, String serviceName, String opid, com.azure.core.util.Context context)	Gets specific OpenID Connect Provider without secrets.
com.azure.core.http.rest.PagedIterable<OpenidConnectProviderContract>	listByService(String resourceGroupName, String serviceName)	Lists of all the OpenId Connect Providers.
com.azure.core.http.rest.PagedIterable<OpenidConnectProviderContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists of all the OpenId Connect Providers.
ClientSecretContract	listSecrets(String resourceGroupName, String serviceName, String opid)	Gets the client secret details of the OpenID Connect Provider.
com.azure.core.http.rest.Response<ClientSecretContract>	listSecretsWithResponse(String resourceGroupName, String serviceName, String opid, com.azure.core.util.Context context)	Gets the client secret details of the OpenID Connect Provider.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<OpenidConnectProviderContract> listByService(String resourceGroupName,
                                                                                    String serviceName)

Lists of all the OpenId Connect Providers.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged OpenIdProviders list representation 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<OpenidConnectProviderContract> listByService(String resourceGroupName,
                                                                                    String serviceName,
                                                                                    String filter,
                                                                                    Integer top,
                                                                                    Integer skip,
                                                                                    com.azure.core.util.Context context)

Lists of all the OpenId Connect Providers.

Parameters:

resourceGroupName - The name of the resource group.

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.

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,
                  String opid)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

opid - Identifier of the OpenID Connect 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.

getEntityTagWithResponse

OpenIdConnectProvidersGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                                    String serviceName,
                                                                    String opid,
                                                                    com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

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

OpenidConnectProviderContract get(String resourceGroupName,
                                  String serviceName,
                                  String opid)

Gets specific OpenID Connect Provider without secrets.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

opid - Identifier of the OpenID Connect Provider.

Returns:

specific OpenID Connect Provider without secrets.

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<OpenidConnectProviderContract> getWithResponse(String resourceGroupName,
                                                                                 String serviceName,
                                                                                 String opid,
                                                                                 com.azure.core.util.Context context)

Gets specific OpenID Connect Provider without secrets.

Parameters:

resourceGroupName - The name of the resource group.

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.

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,
            String opid,
            String ifMatch)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

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,
                                                           String opid,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

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,
                                 String opid)

Gets the client secret details of the OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group.

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.

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,
                                                                                String opid,
                                                                                com.azure.core.util.Context context)

Gets the client secret details of the OpenID Connect Provider.

Parameters:

resourceGroupName - The name of the resource group.

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.

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

OpenidConnectProviderContract getById(String id)

Gets specific OpenID Connect Provider without secrets.

Parameters:

id - the resource ID.

Returns:

specific OpenID Connect Provider without secrets.

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<OpenidConnectProviderContract> getByIdWithResponse(String id,
                                                                                     com.azure.core.util.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.

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 specific OpenID Connect Provider of the API Management service instance.

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

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

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.