ApiOperationPolicy | @azure/arm-apimanagement

Interface representing a ApiOperationPolicy.

Hierarchy

ApiOperationPolicy

Implemented by

ApiOperationPolicyImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: PolicyIdName, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>

- Defined in operationsInterfaces/apiOperationPolicy.ts:92
Creates or updates policy configuration for the API Operation 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.
- operationId: string
  
  Operation identifier within an API. 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: ApiOperationPolicyCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiOperationPolicyCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/apiOperationPolicy.ts:114
Deletes the policy configuration at the Api Operation.

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.
- operationId: string
  
  Operation identifier within an API. 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: ApiOperationPolicyDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: PolicyIdName, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>

- Defined in operationsInterfaces/apiOperationPolicy.ts:72
Get the policy configuration at the API Operation 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.
- operationId: string
  
  Operation identifier within an API. Must be unique in the current API Management service instance.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- Optional options: ApiOperationPolicyGetOptionalParams
  
  The options parameters.
Returns Promise<ApiOperationPolicyGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: PolicyIdName, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagResponse>

- Defined in operationsInterfaces/apiOperationPolicy.ts:53
Gets the entity state (Etag) version of the API operation 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.
- operationId: string
  
  Operation identifier within an API. Must be unique in the current API Management service instance.
- policyId: PolicyIdName
  
  The identifier of the Policy.
- Optional options: ApiOperationPolicyGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ApiOperationPolicyGetEntityTagResponse>

listByOperation

listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<ApiOperationPolicyListByOperationResponse>

- Defined in operationsInterfaces/apiOperationPolicy.ts:35
Get the list of policy configuration at the API Operation 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.
- operationId: string
  
  Operation identifier within an API. Must be unique in the current API Management service instance.
- Optional options: ApiOperationPolicyListByOperationOptionalParams
  
  The options parameters.
Returns Promise<ApiOperationPolicyListByOperationResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

policyId: PolicyIdName

parameters: PolicyContract

Optional options: ApiOperationPolicyCreateOrUpdateOptionalParams

Returns Promise<ApiOperationPolicyCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

policyId: PolicyIdName

ifMatch: string

Optional options: ApiOperationPolicyDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

policyId: PolicyIdName

Optional options: ApiOperationPolicyGetOptionalParams

Returns Promise<ApiOperationPolicyGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

policyId: PolicyIdName

Optional options: ApiOperationPolicyGetEntityTagOptionalParams

Returns Promise<ApiOperationPolicyGetEntityTagResponse>

listByOperation

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

Optional options: ApiOperationPolicyListByOperationOptionalParams

Returns Promise<ApiOperationPolicyListByOperationResponse>