Package com.azure.resourcemanager.apimanagement.models

Interface ApiOperations

public interface ApiOperations

Resource collection API of ApiOperations.

Method Summary

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

Method Detail

listByApi

com.azure.core.http.rest.PagedIterable<OperationContract> 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.

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.

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.

listByApi

com.azure.core.http.rest.PagedIterable<OperationContract> listByApi(String resourceGroupName,
                                                                    String serviceName,
                                                                    String apiId,
                                                                    String filter,
                                                                    Integer top,
                                                                    Integer skip,
                                                                    String tags,
                                                                    com.azure.core.util.Context context)

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.

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.

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

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

ApiOperationsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String apiId,
                                                           String operationId,
                                                           com.azure.core.util.Context context)

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.

context - The context to associate with this operation.

Returns:

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

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

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.

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.

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<OperationContract> getWithResponse(String resourceGroupName,
                                                                     String serviceName,
                                                                     String apiId,
                                                                     String operationId,
                                                                     com.azure.core.util.Context context)

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.

context - The context to associate with this operation.

Returns:

the details of the API Operation specified by its identifier.

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

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 operationId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

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.

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.

getById

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.

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<OperationContract> getByIdWithResponse(String id,
                                                                         com.azure.core.util.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.

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 operation 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 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.

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

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.