ApiPolicy | @azure/arm-apimanagement

Interface representing a ApiPolicy.

Hierarchy

ApiPolicy

Implemented by

ApiPolicyImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: PolicyIdName, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>

- Defined in operationsInterfaces/apiPolicy.ts:81
Creates or updates policy configuration for the API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  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: PolicyIdName
  
  The identifier of the Policy.
- parameters: PolicyContract
  
  The policy contents to apply.
- Optional options: ApiPolicyCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiPolicyCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/apiPolicy.ts:100
Deletes the policy configuration at the Api.

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

get

get(resourceGroupName: string, serviceName: string, apiId: string, policyId: PolicyIdName, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>

- Defined in operationsInterfaces/apiPolicy.ts:64
Get the policy configuration at the API level.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  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: PolicyIdName
  
  The identifier of the Policy.
- Optional options: ApiPolicyGetOptionalParams
  
  The options parameters.
Returns Promise<ApiPolicyGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: PolicyIdName, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagResponse>

- Defined in operationsInterfaces/apiPolicy.ts:48
Gets the entity state (Etag) version of the API policy specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  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: PolicyIdName
  
  The identifier of the Policy.
- Optional options: ApiPolicyGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ApiPolicyGetEntityTagResponse>

listByApi

listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<ApiPolicyListByApiResponse>

- Defined in operationsInterfaces/apiPolicy.ts:33
Get the policy configuration at the API level.

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

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

policyId: PolicyIdName

parameters: PolicyContract

Optional options: ApiPolicyCreateOrUpdateOptionalParams

Returns Promise<ApiPolicyCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

policyId: PolicyIdName

ifMatch: string

Optional options: ApiPolicyDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

policyId: PolicyIdName

Optional options: ApiPolicyGetOptionalParams

Returns Promise<ApiPolicyGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

policyId: PolicyIdName

Optional options: ApiPolicyGetEntityTagOptionalParams

Returns Promise<ApiPolicyGetEntityTagResponse>

listByApi

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiPolicyListByApiOptionalParams

Returns Promise<ApiPolicyListByApiResponse>