metadata

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

Overview

Name	metadata
Type	Resource
Id	azure.resource_health.metadata

Fields

The following fields are returned by SELECT queries:

get_entity

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.
applicableScenarios	array	The list of scenarios applicable to this metadata entity.
dependsOn	array	The list of keys on which this entity depends on.
displayName	string	The display name.
supportedValues	array	The list of supported values.
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".

list

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.
applicableScenarios	array	The list of scenarios applicable to this metadata entity.
dependsOn	array	The list of keys on which this entity depends on.
displayName	string	The display name.
supportedValues	array	The list of supported values.
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
get_entity	select	name		Gets the list of metadata entities.
list	select			Gets the list of metadata entities.

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
name	string	Name of metadata entity. Required.

SELECT examples

get_entity

Gets the list of metadata entities.

SELECT
id,
name,
applicableScenarios,
dependsOn,
displayName,
supportedValues,
systemData,
type
FROM azure.resource_health.metadata
WHERE name = '{{ name }}' -- required
;

list

Gets the list of metadata entities.

SELECT
id,
name,
applicableScenarios,
dependsOn,
displayName,
supportedValues,
systemData,
type
FROM azure.resource_health.metadata
;