policy_descriptions
Creates, updates, deletes, gets or lists a policy_descriptions resource.
Overview
| Name | policy_descriptions |
| Type | Resource |
| Id | azure.api_management.policy_descriptions |
Fields
The following fields are returned by SELECT queries:
- list_by_service
Returns an array of policy descriptions.
| Name | Datatype | Description |
|---|---|---|
properties | object | Policy description contract properties. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_by_service | select | resourceGroupName, serviceName, subscriptionId | scope | Lists all policy descriptions. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
serviceName | string | The name of the API Management service. |
subscriptionId | string | The ID of the target subscription. |
scope | string | Policy scope. |
SELECT examples
- list_by_service
Lists all policy descriptions.
SELECT
properties
FROM azure.api_management.policy_descriptions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND scope = '{{ scope }}'
;