Files
81b83f8618 [AutoPR @azure-arm-alertprocessingrules]-generated-from-SDK Generation - JS-6191237 (#38241)
Configurations:
'specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/AlertProcessingRules/tspconfig.yaml',
API Version: 2021-08-08, SDK Release Type: beta, and CommitSHA:
'4850dea187a72ae7ceaf0bd61b2e4a4c4b4a3b3e' in SpecRepo:
'https://github.com/Azure/azure-rest-api-specs' Pipeline run:
https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6191237
Refer to
https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites
to prepare for SDK release.

---------

Co-authored-by: Jiao Di (MSFT) <[email protected]>
2026-04-23 22:09:08 +08:00

7.4 KiB

API Report File for "@azure/arm-alertprocessingrules"

Do not edit this file. It is a report generated by API Extractor.


import type { ClientOptions } from '@azure-rest/core-client';
import type { OperationOptions } from '@azure-rest/core-client';
import type { Pipeline } from '@azure/core-rest-pipeline';
import type { TokenCredential } from '@azure/core-auth';

// @public
export interface Action {
    actionType: ActionType;
}

// @public
export type ActionType = string;

// @public
export type ActionUnion = AddActionGroups | RemoveAllActionGroups | Action;

// @public
export interface AddActionGroups extends Action {
    actionGroupIds: string[];
    actionType: "AddActionGroups";
}

// @public
export interface AlertProcessingRule extends TrackedResource {
    properties?: AlertProcessingRuleProperties;
}

// @public
export interface AlertProcessingRuleProperties {
    actions: ActionUnion[];
    conditions?: Condition[];
    description?: string;
    enabled?: boolean;
    schedule?: Schedule;
    scopes: string[];
}

// @public
export interface AlertProcessingRulesCreateOrUpdateOptionalParams extends OperationOptions {
}

// @public
export interface AlertProcessingRulesDeleteOptionalParams extends OperationOptions {
}

// @public
export interface AlertProcessingRulesGetByNameOptionalParams extends OperationOptions {
}

// @public
export interface AlertProcessingRulesListByResourceGroupOptionalParams extends OperationOptions {
}

// @public
export interface AlertProcessingRulesListBySubscriptionOptionalParams extends OperationOptions {
}

// @public (undocumented)
export class AlertProcessingRulesManagementClient {
    constructor(credential: TokenCredential, subscriptionId: string, options?: AlertProcessingRulesManagementClientOptionalParams);
    readonly alertProcessingRules: AlertProcessingRulesOperations;
    readonly pipeline: Pipeline;
}

// @public
export interface AlertProcessingRulesManagementClientOptionalParams extends ClientOptions {
    apiVersion?: string;
    cloudSetting?: AzureSupportedClouds;
}

// @public
export interface AlertProcessingRulesOperations {
    createOrUpdate: (resourceGroupName: string, alertProcessingRuleName: string, alertProcessingRule: AlertProcessingRule, options?: AlertProcessingRulesCreateOrUpdateOptionalParams) => Promise<AlertProcessingRule>;
    delete: (resourceGroupName: string, alertProcessingRuleName: string, options?: AlertProcessingRulesDeleteOptionalParams) => Promise<void>;
    getByName: (resourceGroupName: string, alertProcessingRuleName: string, options?: AlertProcessingRulesGetByNameOptionalParams) => Promise<AlertProcessingRule>;
    listByResourceGroup: (resourceGroupName: string, options?: AlertProcessingRulesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<AlertProcessingRule>;
    listBySubscription: (options?: AlertProcessingRulesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<AlertProcessingRule>;
    update: (resourceGroupName: string, alertProcessingRuleName: string, alertProcessingRulePatch: PatchObject, options?: AlertProcessingRulesUpdateOptionalParams) => Promise<AlertProcessingRule>;
}

// @public
export interface AlertProcessingRulesUpdateOptionalParams extends OperationOptions {
}

// @public
export enum AzureClouds {
    AZURE_CHINA_CLOUD = "AZURE_CHINA_CLOUD",
    AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
    AZURE_US_GOVERNMENT = "AZURE_US_GOVERNMENT"
}

// @public
export type AzureSupportedClouds = `${AzureClouds}`;

// @public
export interface Condition {
    field?: Field;
    operator?: Operator;
    values?: string[];
}

// @public
export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
    continuationToken?: string;
};

// @public
export type CreatedByType = string;

// @public
export interface DailyRecurrence extends Recurrence {
    recurrenceType: "Daily";
}

// @public
export type DaysOfWeek = string;

// @public
export interface ErrorResponse {
    error?: ErrorResponseBody;
}

// @public
export interface ErrorResponseBody {
    code?: string;
    details?: ErrorResponseBody[];
    message?: string;
    target?: string;
}

// @public
export type Field = string;

// @public
export enum KnownActionType {
    AddActionGroups = "AddActionGroups",
    RemoveAllActionGroups = "RemoveAllActionGroups"
}

// @public
export enum KnownCreatedByType {
    Application = "Application",
    Key = "Key",
    ManagedIdentity = "ManagedIdentity",
    User = "User"
}

// @public
export enum KnownDaysOfWeek {
    Friday = "Friday",
    Monday = "Monday",
    Saturday = "Saturday",
    Sunday = "Sunday",
    Thursday = "Thursday",
    Tuesday = "Tuesday",
    Wednesday = "Wednesday"
}

// @public
export enum KnownField {
    AlertContext = "AlertContext",
    AlertRuleId = "AlertRuleId",
    AlertRuleName = "AlertRuleName",
    Description = "Description",
    MonitorCondition = "MonitorCondition",
    MonitorService = "MonitorService",
    Severity = "Severity",
    SignalType = "SignalType",
    TargetResource = "TargetResource",
    TargetResourceGroup = "TargetResourceGroup",
    TargetResourceType = "TargetResourceType"
}

// @public
export enum KnownOperator {
    Contains = "Contains",
    DoesNotContain = "DoesNotContain",
    Equals = "Equals",
    NotEquals = "NotEquals"
}

// @public
export enum KnownRecurrenceType {
    Daily = "Daily",
    Monthly = "Monthly",
    Weekly = "Weekly"
}

// @public
export enum KnownVersions {
    V20210808 = "2021-08-08"
}

// @public
export interface MonthlyRecurrence extends Recurrence {
    daysOfMonth: number[];
    recurrenceType: "Monthly";
}

// @public
export type Operator = string;

// @public
export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
    next(): Promise<IteratorResult<TElement>>;
}

// @public
export interface PageSettings {
    continuationToken?: string;
}

// @public
export interface PatchObject {
    enabled?: boolean;
    tags?: Record<string, string>;
}

// @public
export interface PatchProperties {
    enabled?: boolean;
}

// @public
export interface Recurrence {
    endTime?: string;
    recurrenceType: RecurrenceType;
    startTime?: string;
}

// @public
export type RecurrenceType = string;

// @public
export type RecurrenceUnion = DailyRecurrence | WeeklyRecurrence | MonthlyRecurrence | Recurrence;

// @public
export interface RemoveAllActionGroups extends Action {
    actionType: "RemoveAllActionGroups";
}

// @public
export interface Resource {
    readonly id?: string;
    readonly name?: string;
    readonly systemData?: SystemData;
    readonly type?: string;
}

// @public
export interface Schedule {
    effectiveFrom?: string;
    effectiveUntil?: string;
    recurrences?: RecurrenceUnion[];
    timeZone?: string;
}

// @public
export interface SystemData {
    createdAt?: Date;
    createdBy?: string;
    createdByType?: CreatedByType;
    lastModifiedAt?: Date;
    lastModifiedBy?: string;
    lastModifiedByType?: CreatedByType;
}

// @public
export interface TrackedResource extends Resource {
    location: string;
    tags?: Record<string, string>;
}

// @public
export interface WeeklyRecurrence extends Recurrence {
    daysOfWeek: DaysOfWeek[];
    recurrenceType: "Weekly";
}

// (No @packageDocumentation comment for this package)