policy_metadata

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

Overview

Name	policy_metadata
Type	Resource
Id	azure.policy_insights.policy_metadata

Fields

The following fields are returned by SELECT queries:

get_resource

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.
additionalContentUrl	string	Url for getting additional content about the resource metadata.
category	string	The category of the policy metadata.
description	string	The description of the policy metadata.
metadata	object	Additional metadata.
metadataId	string	The policy metadata identifier.
owner	string	The owner of the policy metadata.
requirements	string	The requirements of the policy metadata.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	The title of the policy metadata.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	The ID of the policy metadata.
name	string	The name of the policy metadata.
additionalContentUrl	string	Url for getting additional content about the resource metadata.
category	string	The category of the policy metadata.
metadata	object	Additional metadata.
metadataId	string	The policy metadata identifier.
owner	string	The owner of the policy metadata.
title	string	The title of the policy metadata.
type	string	The type of the policy metadata.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource	select	resource_name		Get policy metadata resource.
list	select		$top	Get a list of the policy metadata resources.

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_name	string	The name of the policy metadata resource. Required.
$top	integer	Maximum number of records to return. Default value is None.

SELECT examples

get_resource

Get policy metadata resource.

SELECT
id,
name,
additionalContentUrl,
category,
description,
metadata,
metadataId,
owner,
requirements,
systemData,
title,
type
FROM azure.policy_insights.policy_metadata
WHERE resource_name = '{{ resource_name }}' -- required
;

list

Get a list of the policy metadata resources.

SELECT
id,
name,
additionalContentUrl,
category,
metadata,
metadataId,
owner,
title,
type
FROM azure.policy_insights.policy_metadata
WHERE $top = '{{ $top }}'
;