MockableMonitorResourceGroupResource.GetByAlertRuleAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a list of incidents associated to an alert rule
- Request Path. : /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}/incidents.
- Operation Id. : AlertRuleIncidentsOperationGroup_ListByAlertRule.
- Default Api Version. : 2016-03-01.
public virtual Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.MonitorIncident> GetByAlertRuleAsync(string ruleName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetByAlertRuleAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.MonitorIncident>
override this.GetByAlertRuleAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Monitor.Models.MonitorIncident>
Public Overridable Function GetByAlertRuleAsync (ruleName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of MonitorIncident)
Parameters
- ruleName
- String
The name of the rule.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
A collection of MonitorIncident that may take multiple service requests to iterate over.
Exceptions
ruleName is null.
ruleName is an empty string, and was expected to be non-empty.