Package com.azure.resourcemanager.apimanagement.models

Interface WorkspaceCertificates

public interface WorkspaceCertificates
Resource collection API of WorkspaceCertificates.

  • Method Details

    • listByWorkspace

      com.azure.core.http.rest.PagedIterable<CertificateContract> listByWorkspace(String resourceGroupName, String serviceName, String workspaceId)
      Lists a collection of all certificates in 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.
      Returns:
      paged Certificates 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.

    • listByWorkspace

      com.azure.core.http.rest.PagedIterable<CertificateContract> listByWorkspace(String resourceGroupName, String serviceName, String workspaceId, String filter, Integer top, Integer skip, Boolean isKeyVaultRefreshFailed, com.azure.core.util.Context context)
      Lists a collection of all certificates in 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.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| expirationDate | filter | ge, le, eq, ne, gt, lt | |</br>.
      top - Number of records to return.
      skip - Number of records to skip.
      isKeyVaultRefreshFailed - When set to true, the response contains only certificates entities which failed refresh.
      context - The context to associate with this operation.
      Returns:
      paged Certificates 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

      WorkspaceCertificatesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String workspaceId, String certificateId, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the certificate 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.
      certificateId - Identifier of the certificate entity. 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 certificate 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, String certificateId)
      Gets the entity state (Etag) version of the certificate 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.
      certificateId - Identifier of the certificate entity. 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

      com.azure.core.http.rest.Response<CertificateContract> getWithResponse(String resourceGroupName, String serviceName, String workspaceId, String certificateId, com.azure.core.util.Context context)
      Gets the details of the certificate 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.
      certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the details of the certificate 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

      CertificateContract get(String resourceGroupName, String serviceName, String workspaceId, String certificateId)
      Gets the details of the certificate 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.
      certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.
      Returns:
      the details of the certificate 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

      com.azure.core.http.rest.Response<CertificateContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceId, String certificateId, CertificateCreateOrUpdateParameters parameters, String ifMatch, com.azure.core.util.Context context)
      Creates or updates the certificate being used for authentication with the backend.
      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.
      certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.
      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:
      certificate 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

      CertificateContract createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, String certificateId, CertificateCreateOrUpdateParameters parameters)
      Creates or updates the certificate being used for authentication with the backend.
      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.
      certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.
      parameters - Create or Update parameters.
      Returns:
      certificate 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 certificateId, String ifMatch, com.azure.core.util.Context context)
      Deletes specific certificate.
      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.
      certificateId - Identifier of the certificate entity. 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 certificateId, String ifMatch)
      Deletes specific certificate.
      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.
      certificateId - Identifier of the certificate entity. 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.

    • refreshSecretWithResponse

      com.azure.core.http.rest.Response<CertificateContract> refreshSecretWithResponse(String resourceGroupName, String serviceName, String workspaceId, String certificateId, com.azure.core.util.Context context)
      From KeyVault, Refresh the certificate being used for authentication with the backend.
      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.
      certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      certificate 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.

    • refreshSecret

      CertificateContract refreshSecret(String resourceGroupName, String serviceName, String workspaceId, String certificateId)
      From KeyVault, Refresh the certificate being used for authentication with the backend.
      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.
      certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.
      Returns:
      certificate 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.