Package com.azure.resourcemanager.apimanagement.models

Interface ApiReleases

public interface ApiReleases
Resource collection API of ApiReleases.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<ApiReleaseContract> listByService(String resourceGroupName, String serviceName, String apiId)
      Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      Returns:
      paged ApiRelease 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<ApiReleaseContract> listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| notes | 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 ApiRelease 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

      ApiReleasesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, com.azure.core.util.Context context)
      Returns the etag of an API release.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      releaseId - Release identifier within an API. Must be unique in the current API Management service instance.
      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.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String apiId, String releaseId)
      Returns the etag of an API release.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      releaseId - Release identifier within an API. 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<ApiReleaseContract> getWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, com.azure.core.util.Context context)
      Returns the details of an API release.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      releaseId - Release identifier within an API. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      apiRelease 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.

    • get

      ApiReleaseContract get(String resourceGroupName, String serviceName, String apiId, String releaseId)
      Returns the details of an API release.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      releaseId - Release identifier within an API. Must be unique in the current API Management service instance.
      Returns:
      apiRelease 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 apiId, String releaseId, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified release in the API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      releaseId - Release identifier within an API. 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 apiId, String releaseId, String ifMatch)
      Deletes the specified release in the API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      releaseId - Release identifier within an API. 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.

    • getById

      ApiReleaseContract getById(String id)
      Returns the details of an API release.
      Parameters:
      id - the resource ID.
      Returns:
      apiRelease 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ApiReleaseContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns the details of an API release.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      apiRelease 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.

    • deleteById

      void deleteById(String id)
      Deletes the specified release in the API.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified release in the API.
      Parameters:
      id - the resource ID.
      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.

    • define

      ApiReleaseContract.DefinitionStages.Blank define(String name)
      Begins definition for a new ApiReleaseContract resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new ApiReleaseContract definition.