ApiPolicies Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ApiPolicies

Resource collection API of ApiPolicies.

Method Summary

Modifier and Type	Method and Description
abstract PolicyContract	createOrUpdate(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters) Creates or updates policy configuration for the API.
abstract Response<PolicyContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, Context context) Creates or updates policy configuration for the API.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, String ifMatch) Deletes the policy configuration at the Api.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, String ifMatch, Context context) Deletes the policy configuration at the Api.
abstract PolicyContract	get(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId) Get the policy configuration at the API level.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId) Gets the entity state (Etag) version of the API policy specified by its identifier.
abstract ApiPoliciesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, Context context) Gets the entity state (Etag) version of the API policy specified by its identifier.
abstract Response<PolicyContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyExportFormat format, Context context) Get the policy configuration at the API level.
abstract PolicyCollection	listByApi(String resourceGroupName, String serviceName, String apiId) Get the policy configuration at the API level.
abstract Response<PolicyCollection>	listByApiWithResponse(String resourceGroupName, String serviceName, String apiId, Context context) Get the policy configuration at the API level.

Method Details

createOrUpdate

public abstract PolicyContract createOrUpdate(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters)

Creates or updates policy configuration for 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.

policyId - The identifier of the Policy.

parameters - The policy contents to apply.

Returns:

policy Contract details.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, Context context)

Creates or updates policy configuration for 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.

policyId - The identifier of the Policy.

parameters - The policy contents to apply.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

policy Contract details.

delete

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

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

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.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, String ifMatch, Context context)

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

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, PolicyIdName policyId)

Get the policy configuration at the API 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.

policyId - The identifier of the Policy.

Returns:

the policy configuration at the API level.

getEntityTag

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

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

policyId - The identifier of the Policy.

getEntityTagWithResponse

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

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

policyId - The identifier of the Policy.

context - The context to associate with this operation.

Returns:

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

getWithResponse

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

Get the policy configuration at the API 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.

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

listByApi

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

Get the policy configuration at the API 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.

Returns:

the policy configuration at the API level.

listByApiWithResponse

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

Get the policy configuration at the API 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.

context - The context to associate with this operation.

Returns:

the policy configuration at the API level along with Response<T>.