@azure/arm-monitor/src/operationsInterfaces/alertRuleIncidents.ts

A generated SDK for MonitorClient.

/*
 * Copyright (c) Microsoft Corporation.
 * Licensed under the MIT License.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 * Changes may cause incorrect behavior and will be lost if the code is regenerated.
 */

import { PagedAsyncIterableIterator } from "@azure/core-paging";
import {
  Incident,
  AlertRuleIncidentsListByAlertRuleOptionalParams,
  AlertRuleIncidentsGetOptionalParams,
  AlertRuleIncidentsGetResponse
} from "../models";

/// <reference lib="esnext.asynciterable" />
/** Interface representing a AlertRuleIncidents. */
export interface AlertRuleIncidents {
  /**
   * Gets a list of incidents associated to an alert rule
   * @param resourceGroupName The name of the resource group. The name is case insensitive.
   * @param ruleName The name of the rule.
   * @param options The options parameters.
   */
  listByAlertRule(
    resourceGroupName: string,
    ruleName: string,
    options?: AlertRuleIncidentsListByAlertRuleOptionalParams
  ): PagedAsyncIterableIterator<Incident>;
  /**
   * Gets an incident associated to an alert rule
   * @param resourceGroupName The name of the resource group. The name is case insensitive.
   * @param ruleName The name of the rule.
   * @param incidentName The name of the incident to retrieve.
   * @param options The options parameters.
   */
  get(
    resourceGroupName: string,
    ruleName: string,
    incidentName: string,
    options?: AlertRuleIncidentsGetOptionalParams
  ): Promise<AlertRuleIncidentsGetResponse>;
}