Skip to main content

all_policies

Creates, updates, deletes, gets or lists an all_policies resource.

Overview

Nameall_policies
TypeResource
Idazure.api_management.all_policies

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
complianceStatestringPolicy Restriction Compliance State. Known values are: "Pending", "NonCompliant", and "Compliant". (Pending, NonCompliant, Compliant)
referencePolicyIdstringPolicy Identifier.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_by_serviceselectresource_group_name, service_name, subscription_idStatus of all policies of API Management services.

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.

NameDatatypeDescription
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
service_namestringThe name of the API Management service. Required.
subscription_idstring

SELECT examples

Status of all policies of API Management services.

SELECT
id,
name,
complianceState,
referencePolicyId,
systemData,
type
FROM azure.api_management.all_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;