Package com.azure.resourcemanager.apimanagement.fluent

Interface PortalRevisionsClient

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

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<PortalRevisionContractInner> listByService(String resourceGroupName, String serviceName)
      Lists developer portal's revisions.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      Returns:
      paged list of portal revisions 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<PortalRevisionContractInner> listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists developer portal's revisions.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| |name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq, ne | |.
      top - Number of records to return.
      skip - Number of records to skip.
      context - The context to associate with this operation.
      Returns:
      paged list of portal revisions 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

      PortalRevisionsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String portalRevisionId, com.azure.core.util.Context context)
      Gets the developer portal revision 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.
      portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the developer portal revision 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 portalRevisionId)
      Gets the developer portal revision 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.
      portalRevisionId - Portal revision 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

      PortalRevisionsGetResponse getWithResponse(String resourceGroupName, String serviceName, String portalRevisionId, com.azure.core.util.Context context)
      Gets the developer portal's revision 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.
      portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the developer portal's revision 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

      PortalRevisionContractInner get(String resourceGroupName, String serviceName, String portalRevisionId)
      Gets the developer portal's revision 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.
      portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.
      Returns:
      the developer portal's revision 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PortalRevisionContractInner>,PortalRevisionContractInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String portalRevisionId, PortalRevisionContractInner parameters)
      Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.
      parameters - The parameters parameter.
      Returns:
      the SyncPoller for polling of portal Revision's 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PortalRevisionContractInner>,PortalRevisionContractInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String portalRevisionId, PortalRevisionContractInner parameters, com.azure.core.util.Context context)
      Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.
      parameters - The parameters parameter.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of portal Revision's 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

      PortalRevisionContractInner createOrUpdate(String resourceGroupName, String serviceName, String portalRevisionId, PortalRevisionContractInner parameters)
      Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.
      parameters - The parameters parameter.
      Returns:
      portal Revision's 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

      PortalRevisionContractInner createOrUpdate(String resourceGroupName, String serviceName, String portalRevisionId, PortalRevisionContractInner parameters, com.azure.core.util.Context context)
      Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.
      parameters - The parameters parameter.
      context - The context to associate with this operation.
      Returns:
      portal Revision's 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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PortalRevisionContractInner>,PortalRevisionContractInner> beginUpdate(String resourceGroupName, String serviceName, String portalRevisionId, String ifMatch, PortalRevisionContractInner parameters)
      Updates the description of specified portal revision or makes it current.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision 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 - The parameters parameter.
      Returns:
      the SyncPoller for polling of portal Revision's 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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PortalRevisionContractInner>,PortalRevisionContractInner> beginUpdate(String resourceGroupName, String serviceName, String portalRevisionId, String ifMatch, PortalRevisionContractInner parameters, com.azure.core.util.Context context)
      Updates the description of specified portal revision or makes it current.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision 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 - The parameters parameter.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of portal Revision's 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.

    • update

      PortalRevisionContractInner update(String resourceGroupName, String serviceName, String portalRevisionId, String ifMatch, PortalRevisionContractInner parameters)
      Updates the description of specified portal revision or makes it current.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision 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 - The parameters parameter.
      Returns:
      portal Revision's 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.

    • update

      PortalRevisionContractInner update(String resourceGroupName, String serviceName, String portalRevisionId, String ifMatch, PortalRevisionContractInner parameters, com.azure.core.util.Context context)
      Updates the description of specified portal revision or makes it current.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalRevisionId - Portal revision 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 - The parameters parameter.
      context - The context to associate with this operation.
      Returns:
      portal Revision's 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.