Fork me on GitHub

Module monitoring

@pulumi/azure > monitoring

Index

monitoring/actionGroup.ts monitoring/alertRule.ts

class ActionGroup

Manages an Action Group within Azure Monitor.

constructor

new ActionGroup(name: string, args: ActionGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ActionGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ActionGroupState): ActionGroup

Get an existing ActionGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property emailReceivers

public emailReceivers: pulumi.Output<{ ... }[] | undefined>;

One or more email_receiver blocks as defined below.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Action Group instance.

property shortName

public shortName: pulumi.Output<string>;

The short name of the action group. This will be used in SMS messages.

property smsReceivers

public smsReceivers: pulumi.Output<{ ... }[] | undefined>;

One or more sms_receiver blocks as defined below.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property webhookReceivers

public webhookReceivers: pulumi.Output<{ ... }[] | undefined>;

One or more webhook_receiver blocks as defined below.

class AlertRule

Manages a metric-based alert rule in Azure Monitor.

constructor

new AlertRule(name: string, args: AlertRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a AlertRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlertRuleState): AlertRule

Get an existing AlertRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property aggregation

public aggregation: pulumi.Output<string>;

Defines how the metric data is combined over time. Possible values are Average, Minimum, Maximum, Total, and Last.

property description

public description: pulumi.Output<string>;

A verbose description of the alert rule that will be included in the alert email.

property emailAction

public emailAction: pulumi.Output<{ ... }>;

A email_action block as defined below.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

If true, the alert rule is enabled. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property metricName

public metricName: pulumi.Output<string>;

The metric that defines what the rule monitors.

property name

public name: pulumi.Output<string>;

Specifies the name of the alert rule. Changing this forces a new resource to be created.

property operator

public operator: pulumi.Output<string>;

The operator used to compare the metric data and the threshold. Possible values are GreaterThan, GreaterThanOrEqual, LessThan, and LessThanOrEqual.

property period

public period: pulumi.Output<string>;

The period of time formatted in ISO 8601 duration format that is used to monitor the alert activity based on the threshold. The period must be between 5 minutes and 1 day.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.

property resourceId

public resourceId: pulumi.Output<string>;

The ID of the resource monitored by the alert rule.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

property threshold

public threshold: pulumi.Output<number>;

The threshold value that activates the alert.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property webhookAction

public webhookAction: pulumi.Output<{ ... }>;

A webhook_action block as defined below.

interface ActionGroupArgs

The set of arguments for constructing a ActionGroup resource.

property emailReceivers

emailReceivers?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more email_receiver blocks as defined below.

property enabled

enabled?: pulumi.Input<boolean>;

Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to true.

property name

name?: pulumi.Input<string>;

The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Action Group instance.

property shortName

shortName: pulumi.Input<string>;

The short name of the action group. This will be used in SMS messages.

property smsReceivers

smsReceivers?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more sms_receiver blocks as defined below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property webhookReceivers

webhookReceivers?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more webhook_receiver blocks as defined below.

interface ActionGroupState

Input properties used for looking up and filtering ActionGroup resources.

property emailReceivers

emailReceivers?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more email_receiver blocks as defined below.

property enabled

enabled?: pulumi.Input<boolean>;

Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to true.

property name

name?: pulumi.Input<string>;

The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Action Group instance.

property shortName

shortName?: pulumi.Input<string>;

The short name of the action group. This will be used in SMS messages.

property smsReceivers

smsReceivers?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more sms_receiver blocks as defined below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property webhookReceivers

webhookReceivers?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more webhook_receiver blocks as defined below.

interface AlertRuleArgs

The set of arguments for constructing a AlertRule resource.

property aggregation

aggregation: pulumi.Input<string>;

Defines how the metric data is combined over time. Possible values are Average, Minimum, Maximum, Total, and Last.

property description

description?: pulumi.Input<string>;

A verbose description of the alert rule that will be included in the alert email.

property emailAction

emailAction?: pulumi.Input<{ ... }>;

A email_action block as defined below.

property enabled

enabled?: pulumi.Input<boolean>;

If true, the alert rule is enabled. Defaults to true.

property location

location: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property metricName

metricName: pulumi.Input<string>;

The metric that defines what the rule monitors.

property name

name?: pulumi.Input<string>;

Specifies the name of the alert rule. Changing this forces a new resource to be created.

property operator

operator: pulumi.Input<string>;

The operator used to compare the metric data and the threshold. Possible values are GreaterThan, GreaterThanOrEqual, LessThan, and LessThanOrEqual.

property period

period: pulumi.Input<string>;

The period of time formatted in ISO 8601 duration format that is used to monitor the alert activity based on the threshold. The period must be between 5 minutes and 1 day.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.

property resourceId

resourceId: pulumi.Input<string>;

The ID of the resource monitored by the alert rule.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

property threshold

threshold: pulumi.Input<number>;

The threshold value that activates the alert.

property webhookAction

webhookAction?: pulumi.Input<{ ... }>;

A webhook_action block as defined below.

interface AlertRuleState

Input properties used for looking up and filtering AlertRule resources.

property aggregation

aggregation?: pulumi.Input<string>;

Defines how the metric data is combined over time. Possible values are Average, Minimum, Maximum, Total, and Last.

property description

description?: pulumi.Input<string>;

A verbose description of the alert rule that will be included in the alert email.

property emailAction

emailAction?: pulumi.Input<{ ... }>;

A email_action block as defined below.

property enabled

enabled?: pulumi.Input<boolean>;

If true, the alert rule is enabled. Defaults to true.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property metricName

metricName?: pulumi.Input<string>;

The metric that defines what the rule monitors.

property name

name?: pulumi.Input<string>;

Specifies the name of the alert rule. Changing this forces a new resource to be created.

property operator

operator?: pulumi.Input<string>;

The operator used to compare the metric data and the threshold. Possible values are GreaterThan, GreaterThanOrEqual, LessThan, and LessThanOrEqual.

property period

period?: pulumi.Input<string>;

The period of time formatted in ISO 8601 duration format that is used to monitor the alert activity based on the threshold. The period must be between 5 minutes and 1 day.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.

property resourceId

resourceId?: pulumi.Input<string>;

The ID of the resource monitored by the alert rule.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

property threshold

threshold?: pulumi.Input<number>;

The threshold value that activates the alert.

property webhookAction

webhookAction?: pulumi.Input<{ ... }>;

A webhook_action block as defined below.