Package com.azure.resourcemanager.apimanagement.fluent

Interface AuthorizationServersClient

public interface AuthorizationServersClient
An instance of this class provides access to all the operations defined in AuthorizationServersClient.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<AuthorizationServerContractInner> listByService(String resourceGroupName, String serviceName)
      Lists a collection of authorization servers defined within a service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      Returns:
      paged OAuth2 Authorization Servers 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<AuthorizationServerContractInner> listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of authorization servers defined within a service instance.
      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 OAuth2 Authorization Servers 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.

    • getEntityTagWithResponse

      AuthorizationServersGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String authsid, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the authorizationServer 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.
      authsid - Identifier of the authorization server.
      context - The context to associate with this operation.
      Returns:
      the entity state (Etag) version of the authorizationServer 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.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String authsid)
      Gets the entity state (Etag) version of the authorizationServer 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.
      authsid - Identifier of the authorization server.
      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

      AuthorizationServersGetResponse getWithResponse(String resourceGroupName, String serviceName, String authsid, com.azure.core.util.Context context)
      Gets the details of the authorization server 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.
      authsid - Identifier of the authorization server.
      context - The context to associate with this operation.
      Returns:
      the details of the authorization server 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

      AuthorizationServerContractInner get(String resourceGroupName, String serviceName, String authsid)
      Gets the details of the authorization server 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.
      authsid - Identifier of the authorization server.
      Returns:
      the details of the authorization server 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.

    • createOrUpdateWithResponse

      AuthorizationServersCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String authsid, AuthorizationServerContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates new authorization server or updates an existing authorization server.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authsid - Identifier of the authorization server.
      parameters - Create or update 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:
      external OAuth authorization server settings.
      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

      AuthorizationServerContractInner createOrUpdate(String resourceGroupName, String serviceName, String authsid, AuthorizationServerContractInner parameters)
      Creates new authorization server or updates an existing authorization server.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authsid - Identifier of the authorization server.
      parameters - Create or update parameters.
      Returns:
      external OAuth authorization server settings.
      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

      AuthorizationServersUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, String authsid, String ifMatch, AuthorizationServerUpdateContract parameters, com.azure.core.util.Context context)
      Updates the details of the authorization server 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.
      authsid - Identifier of the authorization server.
      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 - OAuth2 Server settings Update parameters.
      context - The context to associate with this operation.
      Returns:
      external OAuth authorization server settings.
      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

      AuthorizationServerContractInner update(String resourceGroupName, String serviceName, String authsid, String ifMatch, AuthorizationServerUpdateContract parameters)
      Updates the details of the authorization server 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.
      authsid - Identifier of the authorization server.
      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 - OAuth2 Server settings Update parameters.
      Returns:
      external OAuth authorization server settings.
      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 authsid, String ifMatch, com.azure.core.util.Context context)
      Deletes specific authorization server instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authsid - Identifier of the authorization server.
      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.

    • delete

      void delete(String resourceGroupName, String serviceName, String authsid, String ifMatch)
      Deletes specific authorization server instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authsid - Identifier of the authorization server.
      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.

    • listSecretsWithResponse

      AuthorizationServersListSecretsResponse listSecretsWithResponse(String resourceGroupName, String serviceName, String authsid, com.azure.core.util.Context context)
      Gets the client secret details of the authorization server.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authsid - Identifier of the authorization server.
      context - The context to associate with this operation.
      Returns:
      the client secret details of the authorization server.
      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

      AuthorizationServerSecretsContractInner listSecrets(String resourceGroupName, String serviceName, String authsid)
      Gets the client secret details of the authorization server.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authsid - Identifier of the authorization server.
      Returns:
      the client secret details of the authorization server.
      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.