resource_health_metadata

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

Overview

Name	resource_health_metadata
Type	Resource
Id	azure.web.resource_health_metadata

Fields

The following fields are returned by SELECT queries:

list_by_site_slot

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.
category	string	The category that the resource matches in the RHC Policy File.
kind	string	Kind of resource.
signalAvailability	boolean	Is there a health signal for the resource.
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_by_site

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.
category	string	The category that the resource matches in the RHC Policy File.
kind	string	Kind of resource.
signalAvailability	boolean	Is there a health signal for the resource.
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_by_resource_group

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.
category	string	The category that the resource matches in the RHC Policy File.
kind	string	Kind of resource.
signalAvailability	boolean	Is there a health signal for the resource.
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.
category	string	The category that the resource matches in the RHC Policy File.
kind	string	Kind of resource.
signalAvailability	boolean	Is there a health signal for the resource.
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_site_slot	select	resource_group_name, name, slot, subscription_id		Gets the category of ResourceHealthMetadata to use for the given site as a collection. Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection.
list_by_site	select	resource_group_name, name, subscription_id		Gets the category of ResourceHealthMetadata to use for the given site as a collection. Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection.
list_by_resource_group	select	resource_group_name, subscription_id		List all ResourceHealthMetadata for all sites in the resource group in the subscription. Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.
list	select	subscription_id		List all ResourceHealthMetadata for all sites in the subscription. Description for List all ResourceHealthMetadata for all sites in the subscription.
get_by_site	exec	resource_group_name, name, subscription_id		Gets the category of ResourceHealthMetadata to use for the given site. Description for Gets the category of ResourceHealthMetadata to use for the given site.
get_by_site_slot	exec	resource_group_name, name, slot, subscription_id		Gets the category of ResourceHealthMetadata to use for the given site. Description for Gets the category of ResourceHealthMetadata to use for the given site.

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 web app. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
slot	string	Name of web app slot. If not specified then will default to production slot. Required.
subscription_id	string

SELECT examples

list_by_site_slot

Gets the category of ResourceHealthMetadata to use for the given site as a collection. Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection.

SELECT
id,
name,
category,
kind,
signalAvailability,
systemData,
type
FROM azure.web.resource_health_metadata
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_site

Gets the category of ResourceHealthMetadata to use for the given site as a collection. Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection.

SELECT
id,
name,
category,
kind,
signalAvailability,
systemData,
type
FROM azure.web.resource_health_metadata
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all ResourceHealthMetadata for all sites in the resource group in the subscription. Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.

SELECT
id,
name,
category,
kind,
signalAvailability,
systemData,
type
FROM azure.web.resource_health_metadata
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all ResourceHealthMetadata for all sites in the subscription. Description for List all ResourceHealthMetadata for all sites in the subscription.

SELECT
id,
name,
category,
kind,
signalAvailability,
systemData,
type
FROM azure.web.resource_health_metadata
WHERE subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

get_by_site

Gets the category of ResourceHealthMetadata to use for the given site. Description for Gets the category of ResourceHealthMetadata to use for the given site.

EXEC azure.web.resource_health_metadata.get_by_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_by_site_slot

Gets the category of ResourceHealthMetadata to use for the given site. Description for Gets the category of ResourceHealthMetadata to use for the given site.

EXEC azure.web.resource_health_metadata.get_by_site_slot 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@slot='{{ slot }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;