Policy | @azure/arm-apimanagement

Interface representing a Policy.

Hierarchy

Policy

Implemented by

PolicyImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, policyId: PolicyIdName, parameters: PolicyContract, options?: PolicyCreateOrUpdateOptionalParams): Promise<PolicyCreateOrUpdateResponse>

- Defined in operationsInterfaces/policy.ts:70
Creates or updates the global policy configuration of the Api Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- parameters: PolicyContract
  
  The policy contents to apply.
- Optional options: PolicyCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PolicyCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/policy.ts:86
Deletes the global policy configuration of the Api Management Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- 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: PolicyDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, policyId: PolicyIdName, options?: PolicyGetOptionalParams): Promise<PolicyGetResponse>

- Defined in operationsInterfaces/policy.ts:56
Get the Global policy definition of the Api Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- Optional options: PolicyGetOptionalParams
  
  The options parameters.
Returns Promise<PolicyGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, policyId: PolicyIdName, options?: PolicyGetEntityTagOptionalParams): Promise<PolicyGetEntityTagResponse>

- Defined in operationsInterfaces/policy.ts:43
Gets the entity state (Etag) version of the Global policy definition in the Api Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- Optional options: PolicyGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<PolicyGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: PolicyListByServiceOptionalParams): Promise<PolicyListByServiceResponse>

- Defined in operationsInterfaces/policy.ts:31
Lists all the Global Policy definitions of the Api Management service.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: PolicyListByServiceOptionalParams
  
  The options parameters.
Returns Promise<PolicyListByServiceResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

policyId: PolicyIdName

parameters: PolicyContract

Optional options: PolicyCreateOrUpdateOptionalParams

Returns Promise<PolicyCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

policyId: PolicyIdName

ifMatch: string

Optional options: PolicyDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

policyId: PolicyIdName

Optional options: PolicyGetOptionalParams

Returns Promise<PolicyGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

policyId: PolicyIdName

Optional options: PolicyGetEntityTagOptionalParams

Returns Promise<PolicyGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: PolicyListByServiceOptionalParams

Returns Promise<PolicyListByServiceResponse>