Package com.azure.resourcemanager.apimanagement.fluent

Interface WorkspacesClient

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

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<WorkspaceContractInner> listByService(String resourceGroupName, String serviceName)
      Lists all workspaces of the API Management 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 workspace 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<WorkspaceContractInner> listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists all workspaces of the API Management 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>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br></br>| description | 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 workspace 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

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

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

      WorkspaceContractInner get(String resourceGroupName, String serviceName, String workspaceId)
      Gets the details of the workspace 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.
      Returns:
      the details of the workspace 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

      WorkspacesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceId, WorkspaceContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates a new workspace or updates an existing one.
      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.
      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:
      workspace 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

      WorkspaceContractInner createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, WorkspaceContractInner parameters)
      Creates a new workspace or updates an existing one.
      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.
      parameters - Create parameters.
      Returns:
      workspace 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

      WorkspacesUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, String workspaceId, String ifMatch, WorkspaceContractInner parameters, com.azure.core.util.Context context)
      Updates the details of the workspace 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.
      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 - Workspace Update parameters.
      context - The context to associate with this operation.
      Returns:
      workspace 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

      WorkspaceContractInner update(String resourceGroupName, String serviceName, String workspaceId, String ifMatch, WorkspaceContractInner parameters)
      Updates the details of the workspace 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.
      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 - Workspace Update parameters.
      Returns:
      workspace 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, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified 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.
      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, String ifMatch)
      Deletes the specified 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.
      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.