MonitorExtensions.GetMetricAlertAsync Method

Definition

Retrieve an alert rule definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}
  • Operation Id: MetricAlerts_Get
  • Default Api Version: 2018-03-01
  • Resource: MetricAlertResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Monitor.MetricAlertResource>> GetMetricAlertAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string ruleName, System.Threading.CancellationToken cancellationToken = default);
static member GetMetricAlertAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Monitor.MetricAlertResource>>
<Extension()>
Public Function GetMetricAlertAsync (resourceGroupResource As ResourceGroupResource, ruleName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MetricAlertResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

ruleName
String

The name of the rule.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or ruleName is null.

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

Applies to