Package com.azure.resourcemanager.apimanagement.fluent

Interface WorkspacePoliciesClient

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

  • Method Details

    • listByApi

      com.azure.core.http.rest.PagedIterable<PolicyContractInner> listByApi(String resourceGroupName, String serviceName, String workspaceId)
      Get the policy configuration at the workspace level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      Returns:
      the policy configuration at the workspace level 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.

    • listByApi

      com.azure.core.http.rest.PagedIterable<PolicyContractInner> listByApi(String resourceGroupName, String serviceName, String workspaceId, com.azure.core.util.Context context)
      Get the policy configuration at the workspace level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the policy configuration at the workspace level 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

      WorkspacePoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String workspaceId, PolicyIdName policyId, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the workspace 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.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      context - The context to associate with this operation.
      Returns:
      the entity state (Etag) version of the workspace 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.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String workspaceId, PolicyIdName policyId)
      Gets the entity state (Etag) version of the workspace 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.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      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

      WorkspacePoliciesGetResponse getWithResponse(String resourceGroupName, String serviceName, String workspaceId, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
      Get the policy configuration at the API level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      format - Policy Export Format.
      context - The context to associate with this operation.
      Returns:
      the policy configuration at the API level.
      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

      PolicyContractInner get(String resourceGroupName, String serviceName, String workspaceId, PolicyIdName policyId)
      Get the policy configuration at the API level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      Returns:
      the policy configuration at the API level.
      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

      WorkspacePoliciesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates or updates policy configuration for the workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      parameters - The policy contents to apply.
      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:
      policy Contract 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.

    • createOrUpdate

      PolicyContractInner createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, PolicyIdName policyId, PolicyContractInner parameters)
      Creates or updates policy configuration for the workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      parameters - The policy contents to apply.
      Returns:
      policy Contract 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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String workspaceId, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
      Deletes the policy configuration at the workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the 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 workspaceId, PolicyIdName policyId, String ifMatch)
      Deletes the policy configuration at the workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      policyId - The identifier of the 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.