ProductPolicy interface

Package:

@azure/arm-apimanagement

Interface representing a ProductPolicy.

Methods

createOrUpdate(string, string, string, string, PolicyContract, ProductPolicyCreateOrUpdateOptionalParams)	Creates or updates policy configuration for the Product.
delete(string, string, string, string, string, ProductPolicyDeleteOptionalParams)	Deletes the policy configuration at the Product.
get(string, string, string, string, ProductPolicyGetOptionalParams)	Get the policy configuration at the Product level.
getEntityTag(string, string, string, string, ProductPolicyGetEntityTagOptionalParams)	Get the ETag of the policy configuration at the Product level.
listByProduct(string, string, string, ProductPolicyListByProductOptionalParams)	Get the policy configuration at the Product level.

Method Details

createOrUpdate(string, string, string, string, PolicyContract, ProductPolicyCreateOrUpdateOptionalParams)

Creates or updates policy configuration for the Product.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, policyId: string, parameters: PolicyContract, options?: ProductPolicyCreateOrUpdateOptionalParams): Promise<ProductPolicyCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

productId

string

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

policyId

string

The identifier of the Policy.

parameters

PolicyContract

The policy contents to apply.

options

ProductPolicyCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProductPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ProductPolicyDeleteOptionalParams)

Deletes the policy configuration at the Product.

function delete(resourceGroupName: string, serviceName: string, productId: string, policyId: string, ifMatch: string, options?: ProductPolicyDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

productId

string

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

policyId

string

The identifier of the Policy.

ifMatch

string

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.

options

ProductPolicyDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, ProductPolicyGetOptionalParams)

Get the policy configuration at the Product level.

function get(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetOptionalParams): Promise<ProductPolicyGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

productId

string

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

policyId

string

The identifier of the Policy.

options

ProductPolicyGetOptionalParams

The options parameters.

Returns

Promise<ProductPolicyGetResponse>

getEntityTag(string, string, string, string, ProductPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetEntityTagOptionalParams): Promise<ProductPolicyGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

productId

string

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

policyId

string

The identifier of the Policy.

options

ProductPolicyGetEntityTagOptionalParams

The options parameters.

Returns

Promise<ProductPolicyGetEntityTagHeaders>

listByProduct(string, string, string, ProductPolicyListByProductOptionalParams)

Get the policy configuration at the Product level.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductPolicyListByProductOptionalParams): Promise<PolicyCollection>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

productId

string

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

options

ProductPolicyListByProductOptionalParams

The options parameters.

Returns

Promise<PolicyCollection>