ProductPolicies Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ProductPolicies

Resource collection API of ProductPolicies.

Method Summary

Modifier and Type	Method and Description
abstract PolicyContract	createOrUpdate(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, PolicyContractInner parameters) Creates or updates policy configuration for the Product.
abstract Response<PolicyContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, Context context) Creates or updates policy configuration for the Product.
abstract void	delete(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, String ifMatch) Deletes the policy configuration at the Product.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, String ifMatch, Context context) Deletes the policy configuration at the Product.
abstract PolicyContract	get(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId) Get the policy configuration at the Product level.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId) Get the ETag of the policy configuration at the Product level.
abstract ProductPoliciesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, Context context) Get the ETag of the policy configuration at the Product level.
abstract Response<PolicyContract>	getWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, PolicyExportFormat format, Context context) Get the policy configuration at the Product level.
abstract PolicyCollection	listByProduct(String resourceGroupName, String serviceName, String productId) Get the policy configuration at the Product level.
abstract Response<PolicyCollection>	listByProductWithResponse(String resourceGroupName, String serviceName, String productId, Context context) Get the policy configuration at the Product level.

Method Details

createOrUpdate

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

Creates or updates policy configuration for the Product.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

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

Creates or updates policy configuration for the Product.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

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

Deletes the policy configuration at the Product.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. 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.

deleteWithResponse

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

Deletes the policy configuration at the Product.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. 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 productId, PolicyIdName policyId)

Get the policy configuration at the Product level.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

policyId - The identifier of the Policy.

Returns:

the policy configuration at the Product level.

getEntityTag

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

Get the ETag of the policy configuration at the Product level.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

policyId - The identifier of the Policy.

getEntityTagWithResponse

public abstract ProductPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String productId, PolicyIdName policyId, Context context)

Get the ETag of the policy configuration at the Product level.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. 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 ETag of the policy configuration at the Product level.

getWithResponse

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

Get the policy configuration at the Product level.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. 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 Product level.

listByProduct

public abstract PolicyCollection listByProduct(String resourceGroupName, String serviceName, String productId)

Get the policy configuration at the Product level.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

Returns:

the policy configuration at the Product level.

listByProductWithResponse

public abstract Response listByProductWithResponse(String resourceGroupName, String serviceName, String productId, Context context)

Get the policy configuration at the Product level.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

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