ApiOperationPolicies Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ApiOperationPolicies

Resource collection API of ApiOperationPolicies.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(PolicyIdName name) Begins definition for a new PolicyContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, String ifMatch) Deletes the policy configuration at the Api Operation.
abstract void	deleteById(String id) Deletes the policy configuration at the Api Operation.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the policy configuration at the Api Operation.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, String ifMatch, Context context) Deletes the policy configuration at the Api Operation.
abstract PolicyContract	get(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId) Get the policy configuration at the API Operation level.
abstract PolicyContract	getById(String id) Get the policy configuration at the API Operation level.
abstract Response<PolicyContract>	getByIdWithResponse(String id, PolicyExportFormat format, Context context) Get the policy configuration at the API Operation level.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId) Gets the entity state (Etag) version of the API operation policy specified by its identifier.
abstract ApiOperationPoliciesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, Context context) Gets the entity state (Etag) version of the API operation policy specified by its identifier.
abstract Response<PolicyContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, PolicyExportFormat format, Context context) Get the policy configuration at the API Operation level.
abstract PolicyCollection	listByOperation(String resourceGroupName, String serviceName, String apiId, String operationId) Get the list of policy configuration at the API Operation level.
abstract Response<PolicyCollection>	listByOperationWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, Context context) Get the list of policy configuration at the API Operation level.

Method Details

define

public abstract PolicyContract.DefinitionStages.Blank define(PolicyIdName name)

Begins definition for a new PolicyContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PolicyContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, String ifMatch)

Deletes the policy configuration at the Api Operation.

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.

policyId - The identifier of the Policy.

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 policy configuration at the Api Operation.

Parameters:

id - the resource ID.

deleteByIdWithResponse

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

Deletes the policy configuration at the Api Operation.

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, PolicyIdName policyId, String ifMatch, Context context)

Deletes the policy configuration at the Api Operation.

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.

policyId - The identifier of the Policy.

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 PolicyContract get(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId)

Get the policy configuration at the API Operation level.

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.

policyId - The identifier of the Policy.

Returns:

the policy configuration at the API Operation level.

getById

public abstract PolicyContract getById(String id)

Get the policy configuration at the API Operation level.

Parameters:

id - the resource ID.

Returns:

the policy configuration at the API Operation level.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, PolicyExportFormat format, Context context)

Get the policy configuration at the API Operation level.

Parameters:

id - the resource ID.

format - Policy Export Format.

context - The context to associate with this operation.

Returns:

the policy configuration at the API Operation level.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId)

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

policyId - The identifier of the Policy.

getEntityTagWithResponse

public abstract ApiOperationPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, Context context)

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

policyId - The identifier of the Policy.

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, PolicyExportFormat format, Context context)

Get the policy configuration at the API Operation level.

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.

policyId - The identifier of the Policy.

format - Policy Export Format.

context - The context to associate with this operation.

Returns:

the policy configuration at the API Operation level.

listByOperation

public abstract PolicyCollection listByOperation(String resourceGroupName, String serviceName, String apiId, String operationId)

Get the list of policy configuration at the API Operation level.

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 list of policy configuration at the API Operation level.

listByOperationWithResponse

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

Get the list of policy configuration at the API Operation level.

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 list of policy configuration at the API Operation level along with Response<T>.