Package com.azure.resourcemanager.apimanagement.models

Interface Authorizations

public interface Authorizations
Resource collection API of Authorizations.

  • Method Details

    • listByAuthorizationProvider

      com.azure.core.http.rest.PagedIterable<AuthorizationContract> listByAuthorizationProvider(String resourceGroupName, String serviceName, String authorizationProviderId)
      Lists a collection of authorization providers defined within a authorization provider.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authorizationProviderId - Identifier of the authorization provider.
      Returns:
      paged Authorization 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.

    • listByAuthorizationProvider

      com.azure.core.http.rest.PagedIterable<AuthorizationContract> listByAuthorizationProvider(String resourceGroupName, String serviceName, String authorizationProviderId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of authorization providers defined within a authorization provider.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authorizationProviderId - Identifier of the authorization provider.
      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 Authorization 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.

    • getWithResponse

      com.azure.core.http.rest.Response<AuthorizationContract> getWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, com.azure.core.util.Context context)
      Gets the details of the authorization 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.
      authorizationProviderId - Identifier of the authorization provider.
      authorizationId - Identifier of the authorization.
      context - The context to associate with this operation.
      Returns:
      the details of the authorization 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

      AuthorizationContract get(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId)
      Gets the details of the authorization 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.
      authorizationProviderId - Identifier of the authorization provider.
      authorizationId - Identifier of the authorization.
      Returns:
      the details of the authorization 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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String ifMatch, com.azure.core.util.Context context)
      Deletes specific Authorization from the Authorization provider.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authorizationProviderId - Identifier of the authorization provider.
      authorizationId - Identifier of the authorization.
      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 authorizationProviderId, String authorizationId, String ifMatch)
      Deletes specific Authorization from the Authorization provider.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authorizationProviderId - Identifier of the authorization provider.
      authorizationId - Identifier of the authorization.
      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.

    • confirmConsentCodeWithResponse

      AuthorizationsConfirmConsentCodeResponse confirmConsentCodeWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, AuthorizationConfirmConsentCodeRequestContract parameters, com.azure.core.util.Context context)
      Confirm valid consent code to suppress Authorizations anti-phishing page.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authorizationProviderId - Identifier of the authorization provider.
      authorizationId - Identifier of the authorization.
      parameters - Create parameters.
      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.

    • confirmConsentCode

      void confirmConsentCode(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, AuthorizationConfirmConsentCodeRequestContract parameters)
      Confirm valid consent code to suppress Authorizations anti-phishing page.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      authorizationProviderId - Identifier of the authorization provider.
      authorizationId - Identifier of the authorization.
      parameters - Create parameters.
      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

      AuthorizationContract getById(String id)
      Gets the details of the authorization specified by its identifier.
      Parameters:
      id - the resource ID.
      Returns:
      the details of the authorization 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<AuthorizationContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the details of the authorization specified by its identifier.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the details of the authorization 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.

    • deleteById

      void deleteById(String id)
      Deletes specific Authorization from the Authorization provider.
      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 Authorization from the Authorization provider.
      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

      AuthorizationContract.DefinitionStages.Blank define(String name)
      Begins definition for a new AuthorizationContract resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new AuthorizationContract definition.