ApiOperations Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ApiOperations

Resource collection API of ApiOperations.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new OperationContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String operationId, String ifMatch) Deletes the specified operation in the API.
abstract void	deleteById(String id) Deletes the specified operation in the API.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the specified operation in the API.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, String ifMatch, Context context) Deletes the specified operation in the API.
abstract OperationContract	get(String resourceGroupName, String serviceName, String apiId, String operationId) Gets the details of the API Operation specified by its identifier.
abstract OperationContract	getById(String id) Gets the details of the API Operation specified by its identifier.
abstract Response<OperationContract>	getByIdWithResponse(String id, Context context) Gets the details of the API Operation specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String operationId) Gets the entity state (Etag) version of the API operation specified by its identifier.
abstract ApiOperationsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, Context context) Gets the entity state (Etag) version of the API operation specified by its identifier.
abstract Response<OperationContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, Context context) Gets the details of the API Operation specified by its identifier.
abstract PagedIterable<OperationContract>	listByApi(String resourceGroupName, String serviceName, String apiId) Lists a collection of the operations for the specified API.
abstract PagedIterable<OperationContract>	listByApi(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, String tags, Context context) Lists a collection of the operations for the specified API.

Method Details

define

public abstract OperationContract.DefinitionStages.Blank define(String name)

Begins definition for a new OperationContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new OperationContract definition.

delete

public abstract void delete(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. The name is case insensitive.

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.

deleteById

public abstract void deleteById(String id)

Deletes the specified operation in the API.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Deletes the specified operation 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 operationId, String ifMatch, Context context)

Deletes the specified operation 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 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.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract OperationContract get(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. The name is case insensitive.

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 details of the API Operation specified by its identifier.

getById

public abstract OperationContract getById(String id)

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

Parameters:

id - the resource ID.

Returns:

the details of the API Operation specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

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

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the API Operation specified by its identifier.

getEntityTag

public abstract void getEntityTag(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. The name is case insensitive.

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.

getEntityTagWithResponse

public abstract ApiOperationsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, Context context)

Gets the entity state (Etag) version of the API operation 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.

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.

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, Context context)

Gets the details of the API Operation 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.

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.

context - The context to associate with this operation.

Returns:

the details of the API Operation specified by its identifier.

listByApi

public abstract PagedIterable listByApi(String resourceGroupName, String serviceName, String apiId)

Lists a collection of the operations for the specified API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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:

paged Operation list representation as paginated response with PagedIterable<T>.

listByApi

public abstract PagedIterable listByApi(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, String tags, Context context)

Lists a collection of the operations for the specified API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

tags - Include tags in the response.

context - The context to associate with this operation.

Returns:

paged Operation list representation as paginated response with PagedIterable<T>.