Share via

ApiOperations 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.ApiOperationsInner>

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

Type representing ApiOperations.

Method Summary

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

Deletes the specified operation in the API.
abstract rx.Observable<OperationContract> getAsync(String resourceGroupName, String serviceName, String apiId, String operationId)

Gets the details of the API Operation specified by its identifier.
abstract rx.Completable getEntityTagAsync(String resourceGroupName, String serviceName, String apiId, String operationId)

Gets the entity state (Etag) version of the API operation specified by its identifier.
abstract rx.Observable<OperationContract> listByApiAsync(String resourceGroupName, String serviceName, String apiId)

Lists a collection of the operations for the specified API.

Method Details

deleteAsync

public abstract Completable deleteAsync(String resourceGroupName, String serviceName, String apiId, String operationId, String ifMatch)

Deletes the specified operation in the API.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operationId - Operation 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<OperationContract> getAsync(String resourceGroupName, String serviceName, String apiId, String operationId)

Gets the details of the API Operation specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operationId - Operation 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 operationId)

Gets the entity state (Etag) version of the API operation specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operationId - Operation identifier within an API. Must be unique in the current API Management service instance.

Returns:

the observable for the request

listByApiAsync

public abstract Observable<OperationContract> listByApiAsync(String resourceGroupName, String serviceName, String apiId)

Lists a collection of the operations for the specified API.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Returns:

the observable for the request

Applies to