ApiOperationPolicy interface
Interface representing a ApiOperationPolicy.
Methods
| create |
Creates or updates policy configuration for the API Operation level. |
| delete(string, string, string, string, string, string, Api |
Deletes the policy configuration at the Api Operation. |
| get(string, string, string, string, string, Api |
Get the policy configuration at the API Operation level. |
| get |
Gets the entity state (Etag) version of the API operation policy specified by its identifier. |
| list |
Get the list of policy configuration at the API Operation level. |
Method Details
createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)
Creates or updates policy configuration for the API Operation level.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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
-
string
The identifier of the Policy.
- parameters
- PolicyContract
The policy contents to apply.
The options parameters.
Returns
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Deletes the policy configuration at the Api Operation.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: ApiOperationPolicyDeleteOptionalParams): 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.
- 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
-
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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)
Get the policy configuration at the API Operation level.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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
-
string
The identifier of the Policy.
The options parameters.
Returns
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the API operation policy specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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
-
string
The identifier of the Policy.
The options parameters.
Returns
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Get the list of policy configuration at the API Operation level.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): 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.
- 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.
The options parameters.
Returns
Promise<PolicyCollection>