Package com.azure.resourcemanager.apimanagement.fluent

Interface AuthorizationAccessPoliciesClient

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

  • Method Details

    • listByAuthorization

      com.azure.core.http.rest.PagedIterable<AuthorizationAccessPolicyContractInner> listByAuthorization(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId)
      Lists a collection of authorization access policy defined within a authorization.
      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:
      paged Authorization Access Policy 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.

    • listByAuthorization

      com.azure.core.http.rest.PagedIterable<AuthorizationAccessPolicyContractInner> listByAuthorization(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of authorization access policy defined within a authorization.
      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.
      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 Access Policy 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

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

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

      AuthorizationAccessPoliciesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, AuthorizationAccessPolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates or updates Authorization Access Policy.
      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.
      authorizationAccessPolicyId - Identifier of the authorization access policy.
      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:
      authorization access policy contract.
      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

      AuthorizationAccessPolicyContractInner createOrUpdate(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, AuthorizationAccessPolicyContractInner parameters)
      Creates or updates Authorization Access Policy.
      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.
      authorizationAccessPolicyId - Identifier of the authorization access policy.
      parameters - Create parameters.
      Returns:
      authorization access policy contract.
      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 authorizationAccessPolicyId, String ifMatch, com.azure.core.util.Context context)
      Deletes specific access policy from the Authorization.
      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.
      authorizationAccessPolicyId - Identifier of the authorization access policy.
      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 authorizationAccessPolicyId, String ifMatch)
      Deletes specific access policy from the Authorization.
      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.
      authorizationAccessPolicyId - Identifier of the authorization access policy.
      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.