health_monitors_state_changes

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

Overview

Name	health_monitors_state_changes
Type	Resource
Id	azure.workload_monitor.health_monitors_state_changes

Fields

The following fields are returned by SELECT queries:

get

The health monitor state change matching the specified criteria.

Name	Datatype	Description
id	string	The resource Id. (example: /subscriptions/bc27da3b-3ba2-4e00-a6ec-1fde64aa1e21/resourceGroups/tugamidiAlerts/providers/Microsoft.Compute/virtualMachines/linuxEUS/providers/Microsoft.WorkloadMonitor/monitors/logical-disks|C@3A)
name	string	The resource name. (example: logical-disks|C@3A)
properties	object	Properties of the monitor's state change.
type	string	The resource type. (example: Microsoft.WorkloadMonitor/monitors)

list

The health monitor state changes matching the specified criteria.

Name	Datatype	Description
id	string	The resource Id. (example: /subscriptions/bc27da3b-3ba2-4e00-a6ec-1fde64aa1e21/resourceGroups/tugamidiAlerts/providers/Microsoft.Compute/virtualMachines/linuxEUS/providers/Microsoft.WorkloadMonitor/monitors/logical-disks|C@3A)
name	string	The resource name. (example: logical-disks|C@3A)
properties	object	Properties of the monitor's state change.
type	string	The resource type. (example: Microsoft.WorkloadMonitor/monitors)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, providerName, resourceCollectionName, resourceName, monitorId, timestampUnix	api-version, $expand
list	select	subscriptionId, resourceGroupName, providerName, resourceCollectionName, resourceName, monitorId	api-version, $filter, $expand, startTimestampUtc, endTimestampUtc

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
monitorId	string	The monitor Id of the virtual machine.
providerName	string	The provider name (ex: Microsoft.Compute for virtual machines).
resourceCollectionName	string	The resource collection name (ex: virtualMachines for virtual machines).
resourceGroupName	string	The resource group of the virtual machine.
resourceName	string	The name of the virtual machine.
subscriptionId	string	The subscription Id of the virtual machine.
timestampUnix	string	The timestamp of the state change (unix format).
$expand	string	Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration.
$filter	string	Optionally filter by heartbeat condition. Example: $filter=isHeartbeat eq false.
api-version	string	The API version to use for the operation.
endTimestampUtc	string (date-time)	The end of the time window.
startTimestampUtc	string (date-time)	The start of the time window.

SELECT examples

get

The health monitor state change matching the specified criteria.

SELECT
id,
name,
properties,
type
FROM azure.workload_monitor.health_monitors_state_changes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND providerName = '{{ providerName }}' -- required
AND resourceCollectionName = '{{ resourceCollectionName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND monitorId = '{{ monitorId }}' -- required
AND timestampUnix = '{{ timestampUnix }}' -- required
AND api-version = '{{ api-version }}'
AND $expand = '{{ $expand }}'
;

list

The health monitor state changes matching the specified criteria.

SELECT
id,
name,
properties,
type
FROM azure.workload_monitor.health_monitors_state_changes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND providerName = '{{ providerName }}' -- required
AND resourceCollectionName = '{{ resourceCollectionName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND monitorId = '{{ monitorId }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $expand = '{{ $expand }}'
AND startTimestampUtc = '{{ startTimestampUtc }}'
AND endTimestampUtc = '{{ endTimestampUtc }}'
;