ProductPolicyImpl | @azure/arm-apimanagement

Class containing ProductPolicy operations.

Hierarchy

ProductPolicyImpl

Implements

ProductPolicy

Index

Constructors

constructor

Methods

Constructors

constructor

new ProductPolicyImpl(client: ApiManagementClientContext): ProductPolicyImpl

- Defined in operations/productPolicy.ts:30
Initialize a new instance of the class ProductPolicy class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ProductPolicyImpl

Methods

createOrUpdate

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

Implementation of ProductPolicy.createOrUpdate
- Defined in operations/productPolicy.ts:110
Creates or updates policy configuration for the Product.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- productId: string
  
  Product identifier. Must be unique in the current API Management service instance.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- parameters: PolicyContract
  
  The policy contents to apply.
- Optional options: ProductPolicyCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ProductPolicyCreateOrUpdateResponse>

delete

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

Implementation of ProductPolicy.delete
- Defined in operations/productPolicy.ts:141
Deletes the policy configuration at the Product.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- productId: string
  
  Product identifier. Must be unique in the current API Management service instance.
- policyId: PolicyIdName
  
  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.
- Optional options: ProductPolicyDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of ProductPolicy.get
- Defined in operations/productPolicy.ts:88
Get the policy configuration at the Product level.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- productId: string
  
  Product identifier. Must be unique in the current API Management service instance.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- Optional options: ProductPolicyGetOptionalParams
  
  The options parameters.
Returns Promise<ProductPolicyGetResponse>

getEntityTag

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

Implementation of ProductPolicy.getEntityTag
- Defined in operations/productPolicy.ts:67
Get the ETag of the policy configuration at the Product level.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- productId: string
  
  Product identifier. Must be unique in the current API Management service instance.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- Optional options: ProductPolicyGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ProductPolicyGetEntityTagResponse>

listByProduct

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

Implementation of ProductPolicy.listByProduct
- Defined in operations/productPolicy.ts:47
Get the policy configuration at the Product level.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- productId: string
  
  Product identifier. Must be unique in the current API Management service instance.
- Optional options: ProductPolicyListByProductOptionalParams
  
  The options parameters.
Returns Promise<ProductPolicyListByProductResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ProductPolicyImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

productId: string

policyId: PolicyIdName

parameters: PolicyContract

Optional options: ProductPolicyCreateOrUpdateOptionalParams

Returns Promise<ProductPolicyCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

productId: string

policyId: PolicyIdName

ifMatch: string

Optional options: ProductPolicyDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

productId: string

policyId: PolicyIdName

Optional options: ProductPolicyGetOptionalParams

Returns Promise<ProductPolicyGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

productId: string

policyId: PolicyIdName

Optional options: ProductPolicyGetEntityTagOptionalParams

Returns Promise<ProductPolicyGetEntityTagResponse>

listByProduct

Parameters

resourceGroupName: string

serviceName: string

productId: string

Optional options: ProductPolicyListByProductOptionalParams

Returns Promise<ProductPolicyListByProductResponse>