Share via

ApiReleases Interface

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1

Implements

com.microsoft.azure.arm.collection.SupportsCreating<Blank> com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.ApiReleasesInner>

public interface ApiReleases
extends com.microsoft.azure.arm.collection.SupportsCreating<Blank>, com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.ApiReleasesInner>

Type representing ApiReleases.

Method Summary

Modifier and Type Method and Description
abstract rx.Completable deleteAsync(String resourceGroupName, String serviceName, String apiId, String releaseId, String ifMatch)

Deletes the specified release in the API.
abstract rx.Observable<ApiReleaseContract> getAsync(String resourceGroupName, String serviceName, String apiId, String releaseId)

Returns the details of an API release.
abstract rx.Completable getEntityTagAsync(String resourceGroupName, String serviceName, String apiId, String releaseId)

Returns the etag of an API release.
abstract rx.Observable<ApiReleaseContract> listByServiceAsync(String resourceGroupName, String serviceName, String apiId)

Lists all releases of an API.

Method Details

deleteAsync

public abstract Completable deleteAsync(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.
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.

Returns:

the observable for the request

getAsync

public abstract Observable<ApiReleaseContract> getAsync(String resourceGroupName, String serviceName, String apiId, String releaseId)

Returns the details of an API release.

Parameters:

resourceGroupName - The name of the resource group.
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:

the observable for the request

getEntityTagAsync

public abstract Completable getEntityTagAsync(String resourceGroupName, String serviceName, String apiId, String releaseId)

Returns the etag of an API release.

Parameters:

resourceGroupName - The name of the resource group.
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:

the observable for the request

listByServiceAsync

public abstract Observable<ApiReleaseContract> listByServiceAsync(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.
serviceName - The name of the API Management service.
apiId - API identifier. Must be unique in the current API Management service instance.

Returns:

the observable for the request

Applies to