ApiReleases Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface ApiReleases

Resource collection API of ApiReleases.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new ApiReleaseContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String releaseId, String ifMatch) Deletes the specified release in the API.
abstract void	deleteById(String id) Deletes the specified release in the API.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the specified release in the API.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, String ifMatch, Context context) Deletes the specified release in the API.
abstract ApiReleaseContract	get(String resourceGroupName, String serviceName, String apiId, String releaseId) Returns the details of an API release.
abstract ApiReleaseContract	getById(String id) Returns the details of an API release.
abstract Response<ApiReleaseContract>	getByIdWithResponse(String id, Context context) Returns the details of an API release.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String releaseId) Returns the etag of an API release.
abstract ApiReleasesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, Context context) Returns the etag of an API release.
abstract Response<ApiReleaseContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, Context context) Returns the details of an API release.
abstract PagedIterable<ApiReleaseContract>	listByService(String resourceGroupName, String serviceName, String apiId) Lists all releases of an API.
abstract PagedIterable<ApiReleaseContract>	listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, Context context) Lists all releases of an API.

Method Details

define

public abstract 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.

delete

public abstract 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.

deleteById

public abstract void deleteById(String id)

Deletes the specified release in the API.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, 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<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, String ifMatch, 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<T>.

get

public abstract 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.

getById

public abstract ApiReleaseContract getById(String id)

Returns the details of an API release.

Parameters:

id - the resource ID.

Returns:

apiRelease details.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, 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.

getEntityTag

public abstract 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.

getEntityTagWithResponse

public abstract ApiReleasesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, 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.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiId, String releaseId, 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.

listByService

public abstract PagedIterable 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<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, 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<T>.