Share via


WorkloadMonitorExtensions.GetHealthMonitorAsync Method

Definition

Get the current health status of a monitor of a virtual machine. Optional parameter: $expand (retrieve the monitor's evidence and configuration).

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceCollectionName}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}
  • Operation Id: HealthMonitors_Get
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.WorkloadMonitor.HealthMonitorResource>> GetHealthMonitorAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string providerName, string resourceCollectionName, string resourceName, string monitorId, string expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetHealthMonitorAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.WorkloadMonitor.HealthMonitorResource>>
<Extension()>
Public Function GetHealthMonitorAsync (resourceGroupResource As ResourceGroupResource, providerName As String, resourceCollectionName As String, resourceName As String, monitorId As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of HealthMonitorResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

providerName
String

The provider name (ex: Microsoft.Compute for virtual machines).

resourceCollectionName
String

The resource collection name (ex: virtualMachines for virtual machines).

resourceName
String

The name of the virtual machine.

monitorId
String

The monitor Id of the virtual machine.

expand
String

Optionally expand the monitor’s evidence and/or configuration. Example: $expand=evidence,configuration.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource, providerName, resourceCollectionName, resourceName or monitorId is null.

providerName, resourceCollectionName, resourceName or monitorId is an empty string, and was expected to be non-empty.

Applies to