Microsoft.WorkloadMonitor (preview:2020-01-13)

2025/09/19 • 5 new, 5 deleted methods

Operations_List (new)
Description :  Get a list of all available REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.WorkloadMonitor/operations
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of available REST API operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: True ,
}
string ,
display:
{
Description: The localized display information for this particular operation or action. ,
Required: True ,
}
{
provider:
{
Description: Operation resource provider name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: True ,
}
string ,
operation:
{
Description: Human-readable, friendly name for the operation. ,
Required: True ,
}
string ,
description:
{
Description: Operation description. ,
Required: True ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page if the list is too long. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_List (new)
Description :  Get the current health status of all monitors of a virtual machine. Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by monitor name).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
$filter:
{
Description: Optionally filter by monitor name. Example: $filter=monitorName eq 'logical-disks|C:|disk-free-space-mb.' ,
Required: False ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of health monitors of the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the monitor's health status. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
lastReportedTimestamp:
{
Description: Timestamp of the monitor's last reported health state. ,
Required: False ,
}
string ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page if the list is too long. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_Get (new)
Description :  Get the current health status of a monitor of a virtual machine. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
monitorId:
{
Description: The monitor Id of the virtual machine. ,
Required: True ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the monitor's health status. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
lastReportedTimestamp:
{
Description: Timestamp of the monitor's last reported health state. ,
Required: False ,
}
string ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_ListStateChanges (new)
Description :  Get the health state changes of a monitor of a virtual machine within the provided time window (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by heartbeat condition).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}/history
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
monitorId:
{
Description: The monitor Id of the virtual machine. ,
Required: True ,
}
string ,
$filter:
{
Description: Optionally filter by heartbeat condition. Example: $filter=isHeartbeat eq false. ,
Required: False ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
startTimestampUtc:
{
Description: The start of the time window. ,
Format: date-time ,
Required: False ,
}
string ,
endTimestampUtc:
{
Description: The end of the time window. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of health state changes within the specified time window. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the monitor's state change. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page if the list is too long. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_GetStateChange (new)
Description :  Get the health state change of a monitor of a virtual machine at the provided timestamp. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}/history/{timestampUnix}
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
monitorId:
{
Description: The monitor Id of the virtual machine. ,
Required: True ,
}
string ,
timestampUnix:
{
Description: The timestamp of the state change (unix format). ,
Required: True ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the monitor's state change. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Get a list of all available REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.WorkloadMonitor/operations
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of available REST API operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: True ,
}
string ,
display:
{
Description: The localized display information for this particular operation or action. ,
Required: True ,
}
{
provider:
{
Description: Operation resource provider name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: True ,
}
string ,
operation:
{
Description: Human-readable, friendly name for the operation. ,
Required: True ,
}
string ,
description:
{
Description: Operation description. ,
Required: True ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page if the list is too long. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_List (removed)
Description :  Get the current health status of all monitors of a virtual machine. Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by monitor name).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
$filter:
{
Description: Optionally filter by monitor name. Example: $filter=monitorName eq 'logical-disks|C:|disk-free-space-mb.' ,
Required: False ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of health monitors of the virtual machine. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the monitor's health status. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
lastReportedTimestamp:
{
Description: Timestamp of the monitor's last reported health state. ,
Required: False ,
}
string ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page if the list is too long. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_Get (removed)
Description :  Get the current health status of a monitor of a virtual machine. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
monitorId:
{
Description: The monitor Id of the virtual machine. ,
Required: True ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the monitor's health status. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
lastReportedTimestamp:
{
Description: Timestamp of the monitor's last reported health state. ,
Required: False ,
}
string ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_ListStateChanges (removed)
Description :  Get the health state changes of a monitor of a virtual machine within the provided time window (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by heartbeat condition).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}/history
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
monitorId:
{
Description: The monitor Id of the virtual machine. ,
Required: True ,
}
string ,
$filter:
{
Description: Optionally filter by heartbeat condition. Example: $filter=isHeartbeat eq false. ,
Required: False ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
startTimestampUtc:
{
Description: The start of the time window. ,
Format: date-time ,
Required: False ,
}
string ,
endTimestampUtc:
{
Description: The end of the time window. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of health state changes within the specified time window. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the monitor's state change. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page if the list is too long. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
HealthMonitors_GetStateChange (removed)
Description :  Get the health state change of a monitor of a virtual machine at the provided timestamp. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}/history/{timestampUnix}
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id of the virtual machine. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group of the virtual machine. ,
Required: True ,
}
string ,
providerName:
{
Description: The provider name (ex: Microsoft.Compute for virtual machines). ,
Required: True ,
}
string ,
resourceCollectionName:
{
Description: The resource collection name (ex: virtualMachines for virtual machines). ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
monitorId:
{
Description: The monitor Id of the virtual machine. ,
Required: True ,
}
string ,
timestampUnix:
{
Description: The timestamp of the state change (unix format). ,
Required: True ,
}
string ,
$expand:
{
Description: Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the monitor's state change. ,
Required: False ,
}
{
monitorName:
{
Description: Human-readable name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. ,
Required: False ,
}
string ,
monitoredObject:
{
Description: Dynamic monitored object of the monitor. ,
Required: False ,
}
string ,
evaluationTimestamp:
{
Description: Timestamp of the monitor's last health evaluation. ,
Required: False ,
}
string ,
currentStateFirstObservedTimestamp:
{
Description: Timestamp of the monitor's last health state change. ,
Required: False ,
}
string ,
previousMonitorState:
{
Description: Previous health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
currentMonitorState:
{
Description: Current health state of the monitor. ,
Enum:
{
Healthy: No description available. ,
Critical: No description available. ,
Warning: No description available. ,
Unknown: No description available. ,
Disabled: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
evidence:
{
Description: Evidence validating the monitor's current health state. ,
Required: False ,
}
object ,
monitorConfiguration:
{
Description: The configuration settings at the time of the monitor's health evaluation. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
{
code:
{
Description: Error code identifying the specific error. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable error message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}