policy_description

Creates, updates, deletes, gets or lists a policy_description resource.

Overview

Name	policy_description
Type	Resource
Id	azure.api_management.policy_description

Fields

The following fields are returned by SELECT queries:

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Policy description.
scope	integer	Binary OR value of the Snippet scope.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_service	select	resource_group_name, service_name, subscription_id	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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
scope	string	Policy scope. Known values are: "Tenant", "Product", "Api", "Operation", and "All". Default value is None.

SELECT examples

list_by_service

Lists all policy descriptions.

SELECT
id,
name,
description,
scope,
systemData,
type
FROM azure.api_management.policy_description
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND scope = '{{ scope }}'
;