HealthMonitorCollection.GetAsync(String, String, CancellationToken) 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 virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.WorkloadMonitor.HealthMonitorResource>> GetAsync (string monitorId, string expand = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.WorkloadMonitor.HealthMonitorResource>>
override this.GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.WorkloadMonitor.HealthMonitorResource>>
Public Overridable Function GetAsync (monitorId As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of HealthMonitorResource))

Parameters

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

monitorId is an empty string, and was expected to be non-empty.

monitorId is null.

Applies to