Package com.azure.resourcemanager.apimanagement.fluent

Interface OpenIdConnectProvidersClient

public interface OpenIdConnectProvidersClient

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

Method Summary

Modifier and Type	Method	Description
OpenidConnectProviderContractInner	createOrUpdate(String resourceGroupName, String serviceName, String opid, OpenidConnectProviderContractInner parameters)	Creates or updates the OpenID Connect Provider.
OpenIdConnectProvidersCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String opid, OpenidConnectProviderContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Creates or updates the OpenID Connect Provider.
void	delete(String resourceGroupName, String serviceName, String opid, String ifMatch)	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.
OpenidConnectProviderContractInner	get(String resourceGroupName, String serviceName, String opid)	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.
OpenIdConnectProvidersGetResponse	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<OpenidConnectProviderContractInner>	listByService(String resourceGroupName, String serviceName)	Lists of all the OpenId Connect Providers.
com.azure.core.http.rest.PagedIterable<OpenidConnectProviderContractInner>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists of all the OpenId Connect Providers.
ClientSecretContractInner	listSecrets(String resourceGroupName, String serviceName, String opid)	Gets the client secret details of the OpenID Connect Provider.
OpenIdConnectProvidersListSecretsResponse	listSecretsWithResponse(String resourceGroupName, String serviceName, String opid, com.azure.core.util.Context context)	Gets the client secret details of the OpenID Connect Provider.
OpenidConnectProviderContractInner	update(String resourceGroupName, String serviceName, String opid, String ifMatch, OpenidConnectProviderUpdateContract parameters)	Updates the specific OpenID Connect Provider.
OpenIdConnectProvidersUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, String opid, String ifMatch, OpenidConnectProviderUpdateContract parameters, com.azure.core.util.Context context)	Updates the specific OpenID Connect Provider.

Method Detail

listByService

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

OpenidConnectProviderContractInner 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

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

createOrUpdate

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.

serviceName - The name of the API Management service.

opid - Identifier of the OpenID Connect Provider.

parameters - Create parameters.

Returns:

openId Connect 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

OpenIdConnectProvidersCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                                        String serviceName,
                                                                        String opid,
                                                                        OpenidConnectProviderContractInner parameters,
                                                                        String ifMatch,
                                                                        com.azure.core.util.Context context)

Creates or updates 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.

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.

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

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.

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.

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

OpenIdConnectProvidersUpdateResponse updateWithResponse(String resourceGroupName,
                                                        String serviceName,
                                                        String opid,
                                                        String ifMatch,
                                                        OpenidConnectProviderUpdateContract parameters,
                                                        com.azure.core.util.Context context)

Updates the specific 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.

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.

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

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.

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

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