monitoring

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.monitoring.ActionGroup(resource_name, opts=None, email_receivers=None, enabled=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, tags=None, webhook_receivers=None, __props__=None, __name__=None, __opts__=None)

Manages an Action Group within Azure Monitor.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • email_receivers (pulumi.Input[list]) – One or more email_receiver blocks as defined below.

  • enabled (pulumi.Input[bool]) – Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to true.

  • name (pulumi.Input[str]) – The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Action Group instance.

  • short_name (pulumi.Input[str]) – The short name of the action group. This will be used in SMS messages.

  • sms_receivers (pulumi.Input[list]) – One or more sms_receiver blocks as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • webhook_receivers (pulumi.Input[list]) – One or more webhook_receiver blocks as defined below.

The email_receivers object supports the following:

  • emailAddress (pulumi.Input[str]) - The email address of this receiver.

  • name (pulumi.Input[str]) - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

The sms_receivers object supports the following:

  • countryCode (pulumi.Input[str]) - The country code of the SMS receiver.

  • name (pulumi.Input[str]) - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

  • phoneNumber (pulumi.Input[str]) - The phone number of the SMS receiver.

The webhook_receivers object supports the following:

  • name (pulumi.Input[str]) - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

  • service_uri (pulumi.Input[str]) - The URI where webhooks should be sent.

email_receivers = None

One or more email_receiver blocks as defined below.

  • emailAddress (str) - The email address of this receiver.

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

enabled = None

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

name = None

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

resource_group_name = None

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

short_name = None

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

sms_receivers = None

One or more sms_receiver blocks as defined below.

  • countryCode (str) - The country code of the SMS receiver.

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

  • phoneNumber (str) - The phone number of the SMS receiver.

tags = None

A mapping of tags to assign to the resource.

webhook_receivers = None

One or more webhook_receiver blocks as defined below.

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

  • service_uri (str) - The URI where webhooks should be sent.

static get(resource_name, id, opts=None, email_receivers=None, enabled=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, tags=None, webhook_receivers=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • email_receivers (pulumi.Input[list]) – One or more email_receiver blocks as defined below.

  • enabled (pulumi.Input[bool]) – Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to true.

  • name (pulumi.Input[str]) – The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Action Group instance.

  • short_name (pulumi.Input[str]) – The short name of the action group. This will be used in SMS messages.

  • sms_receivers (pulumi.Input[list]) – One or more sms_receiver blocks as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • webhook_receivers (pulumi.Input[list]) – One or more webhook_receiver blocks as defined below.

The email_receivers object supports the following:

  • emailAddress (pulumi.Input[str]) - The email address of this receiver.

  • name (pulumi.Input[str]) - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

The sms_receivers object supports the following:

  • countryCode (pulumi.Input[str]) - The country code of the SMS receiver.

  • name (pulumi.Input[str]) - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

  • phoneNumber (pulumi.Input[str]) - The phone number of the SMS receiver.

The webhook_receivers object supports the following:

  • name (pulumi.Input[str]) - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

  • service_uri (pulumi.Input[str]) - The URI where webhooks should be sent.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.monitoring.ActivityLogAlert(resource_name, opts=None, actions=None, criteria=None, description=None, enabled=None, name=None, resource_group_name=None, scopes=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Activity Log Alert within Azure Monitor.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – One or more action blocks as defined below.

  • criteria (pulumi.Input[dict]) – A criteria block as defined below.

  • description (pulumi.Input[str]) – The description of this activity log alert.

  • enabled (pulumi.Input[bool]) – Should this Activity Log Alert be enabled? Defaults to true.

  • name (pulumi.Input[str]) – The name of the activity log alert. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the activity log alert instance.

  • scopes (pulumi.Input[list]) – The Scope at which the Activity Log should be applied, for example a the Resource ID of a Subscription or a Resource (such as a Storage Account).

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The actions object supports the following:

  • actionGroupId (pulumi.Input[str])

  • webhookProperties (pulumi.Input[dict])

The criteria object supports the following:

  • caller (pulumi.Input[str])

  • category (pulumi.Input[str])

  • level (pulumi.Input[str])

  • operationName (pulumi.Input[str])

  • resourceGroup (pulumi.Input[str])

  • resource_id (pulumi.Input[str])

  • resourceProvider (pulumi.Input[str])

  • resourceType (pulumi.Input[str])

  • status (pulumi.Input[str])

  • subStatus (pulumi.Input[str])

actions = None

One or more action blocks as defined below.

  • actionGroupId (str)

  • webhookProperties (dict)

criteria = None

A criteria block as defined below.

  • caller (str)

  • category (str)

  • level (str)

  • operationName (str)

  • resourceGroup (str)

  • resource_id (str)

  • resourceProvider (str)

  • resourceType (str)

  • status (str)

  • subStatus (str)

description = None

The description of this activity log alert.

enabled = None

Should this Activity Log Alert be enabled? Defaults to true.

name = None

The name of the activity log alert. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the activity log alert instance.

scopes = None

The Scope at which the Activity Log should be applied, for example a the Resource ID of a Subscription or a Resource (such as a Storage Account).

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, actions=None, criteria=None, description=None, enabled=None, name=None, resource_group_name=None, scopes=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – One or more action blocks as defined below.

  • criteria (pulumi.Input[dict]) – A criteria block as defined below.

  • description (pulumi.Input[str]) – The description of this activity log alert.

  • enabled (pulumi.Input[bool]) – Should this Activity Log Alert be enabled? Defaults to true.

  • name (pulumi.Input[str]) – The name of the activity log alert. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the activity log alert instance.

  • scopes (pulumi.Input[list]) – The Scope at which the Activity Log should be applied, for example a the Resource ID of a Subscription or a Resource (such as a Storage Account).

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The actions object supports the following:

  • actionGroupId (pulumi.Input[str])

  • webhookProperties (pulumi.Input[dict])

The criteria object supports the following:

  • caller (pulumi.Input[str])

  • category (pulumi.Input[str])

  • level (pulumi.Input[str])

  • operationName (pulumi.Input[str])

  • resourceGroup (pulumi.Input[str])

  • resource_id (pulumi.Input[str])

  • resourceProvider (pulumi.Input[str])

  • resourceType (pulumi.Input[str])

  • status (pulumi.Input[str])

  • subStatus (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.monitoring.AlertRule(resource_name, opts=None, aggregation=None, description=None, email_action=None, enabled=None, location=None, metric_name=None, name=None, operator=None, period=None, resource_group_name=None, resource_id=None, tags=None, threshold=None, webhook_action=None, __props__=None, __name__=None, __opts__=None)

Manages a metric-based alert rule in Azure Monitor.

NOTE: This resource has been deprecated in favour of the monitoring.MetricAlertRule resource and will be removed in the next major version of the AzureRM Provider. The new resource shares the same fields as this one, and information on migrating across can be found in this guide.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aggregation (pulumi.Input[str]) – Defines how the metric data is combined over time. Possible values are Average, Minimum, Maximum, Total, and Last.

  • description (pulumi.Input[str]) – A verbose description of the alert rule that will be included in the alert email.

  • email_action (pulumi.Input[dict]) – A email_action block as defined below.

  • enabled (pulumi.Input[bool]) – If true, the alert rule is enabled. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • metric_name (pulumi.Input[str]) – The metric that defines what the rule monitors.

  • name (pulumi.Input[str]) – Specifies the name of the alert rule. Changing this forces a new resource to be created.

  • operator (pulumi.Input[str]) – The operator used to compare the metric data and the threshold. Possible values are GreaterThan, GreaterThanOrEqual, LessThan, and LessThanOrEqual.

  • period (pulumi.Input[str]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The ID of the resource monitored by the alert rule.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

  • threshold (pulumi.Input[float]) – The threshold value that activates the alert.

  • webhook_action (pulumi.Input[dict]) – A webhook_action block as defined below.

The email_action object supports the following:

  • customEmails (pulumi.Input[list]) - A list of email addresses to be notified when the alert is triggered.

  • sendToServiceOwners (pulumi.Input[bool]) - If true, the administrators (service and co-administrators) of the subscription are notified when the alert is triggered. Defaults to false.

The webhook_action object supports the following:

  • properties (pulumi.Input[dict]) - A dictionary of custom properties to include with the webhook POST operation payload.

  • service_uri (pulumi.Input[str]) - The service uri of the webhook to POST the notification when the alert is triggered.

aggregation = None

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

description = None

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

email_action = None

A email_action block as defined below.

  • customEmails (list) - A list of email addresses to be notified when the alert is triggered.

  • sendToServiceOwners (bool) - If true, the administrators (service and co-administrators) of the subscription are notified when the alert is triggered. Defaults to false.

enabled = None

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

location = None

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

metric_name = None

The metric that defines what the rule monitors.

name = None

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

operator = None

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

period = None

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.

resource_group_name = None

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

resource_id = None

The ID of the resource monitored by the alert rule.

tags = None

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

threshold = None

The threshold value that activates the alert.

webhook_action = None

A webhook_action block as defined below.

  • properties (dict) - A dictionary of custom properties to include with the webhook POST operation payload.

  • service_uri (str) - The service uri of the webhook to POST the notification when the alert is triggered.

static get(resource_name, id, opts=None, aggregation=None, description=None, email_action=None, enabled=None, location=None, metric_name=None, name=None, operator=None, period=None, resource_group_name=None, resource_id=None, tags=None, threshold=None, webhook_action=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aggregation (pulumi.Input[str]) – Defines how the metric data is combined over time. Possible values are Average, Minimum, Maximum, Total, and Last.

  • description (pulumi.Input[str]) – A verbose description of the alert rule that will be included in the alert email.

  • email_action (pulumi.Input[dict]) – A email_action block as defined below.

  • enabled (pulumi.Input[bool]) – If true, the alert rule is enabled. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • metric_name (pulumi.Input[str]) – The metric that defines what the rule monitors.

  • name (pulumi.Input[str]) – Specifies the name of the alert rule. Changing this forces a new resource to be created.

  • operator (pulumi.Input[str]) – The operator used to compare the metric data and the threshold. Possible values are GreaterThan, GreaterThanOrEqual, LessThan, and LessThanOrEqual.

  • period (pulumi.Input[str]) –

    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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The ID of the resource monitored by the alert rule.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

  • threshold (pulumi.Input[float]) – The threshold value that activates the alert.

  • webhook_action (pulumi.Input[dict]) – A webhook_action block as defined below.

The email_action object supports the following:

  • customEmails (pulumi.Input[list]) - A list of email addresses to be notified when the alert is triggered.

  • sendToServiceOwners (pulumi.Input[bool]) - If true, the administrators (service and co-administrators) of the subscription are notified when the alert is triggered. Defaults to false.

The webhook_action object supports the following:

  • properties (pulumi.Input[dict]) - A dictionary of custom properties to include with the webhook POST operation payload.

  • service_uri (pulumi.Input[str]) - The service uri of the webhook to POST the notification when the alert is triggered.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.monitoring.AutoscaleSetting(resource_name, opts=None, enabled=None, location=None, name=None, notification=None, profiles=None, resource_group_name=None, tags=None, target_resource_id=None, __props__=None, __name__=None, __opts__=None)

Manages a AutoScale Setting which can be applied to Virtual Machine Scale Sets, App Services and other scalable resources.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Specifies whether automatic scaling is enabled for the target resource. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • notification (pulumi.Input[dict]) – Specifies a notification block as defined below.

  • profiles (pulumi.Input[list]) – Specifies one or more (up to 20) profile blocks as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_resource_id (pulumi.Input[str]) – Specifies the resource ID of the resource that the autoscale setting should be added to.

The notification object supports the following:

  • email (pulumi.Input[dict])

    • customEmails (pulumi.Input[list])

    • sendToSubscriptionAdministrator (pulumi.Input[bool])

    • sendToSubscriptionCoAdministrator (pulumi.Input[bool])

  • webhooks (pulumi.Input[list])

    • properties (pulumi.Input[dict])

    • service_uri (pulumi.Input[str])

The profiles object supports the following:

  • capacity (pulumi.Input[dict])

    • default (pulumi.Input[float])

    • maximum (pulumi.Input[float])

    • minimum (pulumi.Input[float])

  • fixedDate (pulumi.Input[dict])

    • end (pulumi.Input[str])

    • start (pulumi.Input[str])

    • timezone (pulumi.Input[str])

  • name (pulumi.Input[str]) - The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • recurrence (pulumi.Input[dict])

    • days (pulumi.Input[list])

    • hours (pulumi.Input[float])

    • minutes (pulumi.Input[float])

    • timezone (pulumi.Input[str])

  • rules (pulumi.Input[list])

    • metricTrigger (pulumi.Input[dict])

      • metric_name (pulumi.Input[str])

      • metricResourceId (pulumi.Input[str])

      • operator (pulumi.Input[str])

      • statistic (pulumi.Input[str])

      • threshold (pulumi.Input[float])

      • timeAggregation (pulumi.Input[str])

      • timeGrain (pulumi.Input[str])

      • timeWindow (pulumi.Input[str])

    • scaleAction (pulumi.Input[dict])

      • cooldown (pulumi.Input[str])

      • direction (pulumi.Input[str])

      • type (pulumi.Input[str])

      • value (pulumi.Input[float])

enabled = None

Specifies whether automatic scaling is enabled for the target resource. Defaults to true.

location = None

Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created.

name = None

The name of the AutoScale Setting. Changing this forces a new resource to be created.

notification = None

Specifies a notification block as defined below.

  • email (dict)

    • customEmails (list)

    • sendToSubscriptionAdministrator (bool)

    • sendToSubscriptionCoAdministrator (bool)

  • webhooks (list)

    • properties (dict)

    • service_uri (str)

profiles = None

Specifies one or more (up to 20) profile blocks as defined below.

  • capacity (dict)

    • default (float)

    • maximum (float)

    • minimum (float)

  • fixedDate (dict)

    • end (str)

    • start (str)

    • timezone (str)

  • name (str) - The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • recurrence (dict)

    • days (list)

    • hours (float)

    • minutes (float)

    • timezone (str)

  • rules (list)

    • metricTrigger (dict)

      • metric_name (str)

      • metricResourceId (str)

      • operator (str)

      • statistic (str)

      • threshold (float)

      • timeAggregation (str)

      • timeGrain (str)

      • timeWindow (str)

    • scaleAction (dict)

      • cooldown (str)

      • direction (str)

      • type (str)

      • value (float)

resource_group_name = None

The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource.

target_resource_id = None

Specifies the resource ID of the resource that the autoscale setting should be added to.

static get(resource_name, id, opts=None, enabled=None, location=None, name=None, notification=None, profiles=None, resource_group_name=None, tags=None, target_resource_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Specifies whether automatic scaling is enabled for the target resource. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • notification (pulumi.Input[dict]) – Specifies a notification block as defined below.

  • profiles (pulumi.Input[list]) – Specifies one or more (up to 20) profile blocks as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_resource_id (pulumi.Input[str]) – Specifies the resource ID of the resource that the autoscale setting should be added to.

The notification object supports the following:

  • email (pulumi.Input[dict])

    • customEmails (pulumi.Input[list])

    • sendToSubscriptionAdministrator (pulumi.Input[bool])

    • sendToSubscriptionCoAdministrator (pulumi.Input[bool])

  • webhooks (pulumi.Input[list])

    • properties (pulumi.Input[dict])

    • service_uri (pulumi.Input[str])

The profiles object supports the following:

  • capacity (pulumi.Input[dict])

    • default (pulumi.Input[float])

    • maximum (pulumi.Input[float])

    • minimum (pulumi.Input[float])

  • fixedDate (pulumi.Input[dict])

    • end (pulumi.Input[str])

    • start (pulumi.Input[str])

    • timezone (pulumi.Input[str])

  • name (pulumi.Input[str]) - The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • recurrence (pulumi.Input[dict])

    • days (pulumi.Input[list])

    • hours (pulumi.Input[float])

    • minutes (pulumi.Input[float])

    • timezone (pulumi.Input[str])

  • rules (pulumi.Input[list])

    • metricTrigger (pulumi.Input[dict])

      • metric_name (pulumi.Input[str])

      • metricResourceId (pulumi.Input[str])

      • operator (pulumi.Input[str])

      • statistic (pulumi.Input[str])

      • threshold (pulumi.Input[float])

      • timeAggregation (pulumi.Input[str])

      • timeGrain (pulumi.Input[str])

      • timeWindow (pulumi.Input[str])

    • scaleAction (pulumi.Input[dict])

      • cooldown (pulumi.Input[str])

      • direction (pulumi.Input[str])

      • type (pulumi.Input[str])

      • value (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.monitoring.AwaitableGetActionGroupResult(email_receivers=None, enabled=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, webhook_receivers=None, id=None)
class pulumi_azure.monitoring.AwaitableGetDiagnosticCategoriesResult(logs=None, metrics=None, resource_id=None, id=None)
class pulumi_azure.monitoring.AwaitableGetLogProfileResult(categories=None, locations=None, name=None, retention_policy=None, servicebus_rule_id=None, storage_account_id=None, id=None)
class pulumi_azure.monitoring.DiagnosticSetting(resource_name, opts=None, eventhub_authorization_rule_id=None, eventhub_name=None, logs=None, log_analytics_destination_type=None, log_analytics_workspace_id=None, metrics=None, name=None, storage_account_id=None, target_resource_id=None, __props__=None, __name__=None, __opts__=None)

Manages a Diagnostic Setting for an existing Resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_authorization_rule_id (pulumi.Input[str]) – Specifies the ID of an Event Hub Namespace Authorization Rule used to send Diagnostics Data. Changing this forces a new resource to be created.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the Event Hub where Diagnostics Data should be sent. Changing this forces a new resource to be created.

  • logs (pulumi.Input[list]) – One or more log blocks as defined below.

  • log_analytics_destination_type (pulumi.Input[str]) – When set to ‘Dedicated’ logs sent to a Log Analytics workspace will go into resource specific tables, instead of the legacy AzureDiagnostics table.

  • log_analytics_workspace_id (pulumi.Input[str]) – Specifies the ID of a Log Analytics Workspace where Diagnostics Data should be sent. Changing this forces a new resource to be created.

  • metrics (pulumi.Input[list]) – One or more metric blocks as defined below.

  • name (pulumi.Input[str]) – Specifies the name of the Diagnostic Setting. Changing this forces a new resource to be created.

  • storage_account_id (pulumi.Input[str]) – With this parameter you can specify a storage account which should be used to send the logs to. Parameter must be a valid Azure Resource ID. Changing this forces a new resource to be created.

  • target_resource_id (pulumi.Input[str]) – The ID of an existing Resource on which to configure Diagnostic Settings. Changing this forces a new resource to be created.

The logs object supports the following:

  • category (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • retention_policy (pulumi.Input[dict])

    • days (pulumi.Input[float])

    • enabled (pulumi.Input[bool])

The metrics object supports the following:

  • category (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • retention_policy (pulumi.Input[dict])

    • days (pulumi.Input[float])

    • enabled (pulumi.Input[bool])

eventhub_authorization_rule_id = None

Specifies the ID of an Event Hub Namespace Authorization Rule used to send Diagnostics Data. Changing this forces a new resource to be created.

eventhub_name = None

Specifies the name of the Event Hub where Diagnostics Data should be sent. Changing this forces a new resource to be created.

logs = None

One or more log blocks as defined below.

  • category (str)

  • enabled (bool)

  • retention_policy (dict)

    • days (float)

    • enabled (bool)

log_analytics_destination_type = None

When set to ‘Dedicated’ logs sent to a Log Analytics workspace will go into resource specific tables, instead of the legacy AzureDiagnostics table.

log_analytics_workspace_id = None

Specifies the ID of a Log Analytics Workspace where Diagnostics Data should be sent. Changing this forces a new resource to be created.

metrics = None

One or more metric blocks as defined below.

  • category (str)

  • enabled (bool)

  • retention_policy (dict)

    • days (float)

    • enabled (bool)

name = None

Specifies the name of the Diagnostic Setting. Changing this forces a new resource to be created.

storage_account_id = None

With this parameter you can specify a storage account which should be used to send the logs to. Parameter must be a valid Azure Resource ID. Changing this forces a new resource to be created.

target_resource_id = None

The ID of an existing Resource on which to configure Diagnostic Settings. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, eventhub_authorization_rule_id=None, eventhub_name=None, logs=None, log_analytics_destination_type=None, log_analytics_workspace_id=None, metrics=None, name=None, storage_account_id=None, target_resource_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_authorization_rule_id (pulumi.Input[str]) – Specifies the ID of an Event Hub Namespace Authorization Rule used to send Diagnostics Data. Changing this forces a new resource to be created.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the Event Hub where Diagnostics Data should be sent. Changing this forces a new resource to be created.

  • logs (pulumi.Input[list]) – One or more log blocks as defined below.

  • log_analytics_destination_type (pulumi.Input[str]) – When set to ‘Dedicated’ logs sent to a Log Analytics workspace will go into resource specific tables, instead of the legacy AzureDiagnostics table.

  • log_analytics_workspace_id (pulumi.Input[str]) – Specifies the ID of a Log Analytics Workspace where Diagnostics Data should be sent. Changing this forces a new resource to be created.

  • metrics (pulumi.Input[list]) – One or more metric blocks as defined below.

  • name (pulumi.Input[str]) – Specifies the name of the Diagnostic Setting. Changing this forces a new resource to be created.

  • storage_account_id (pulumi.Input[str]) – With this parameter you can specify a storage account which should be used to send the logs to. Parameter must be a valid Azure Resource ID. Changing this forces a new resource to be created.

  • target_resource_id (pulumi.Input[str]) – The ID of an existing Resource on which to configure Diagnostic Settings. Changing this forces a new resource to be created.

The logs object supports the following:

  • category (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • retention_policy (pulumi.Input[dict])

    • days (pulumi.Input[float])

    • enabled (pulumi.Input[bool])

The metrics object supports the following:

  • category (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • retention_policy (pulumi.Input[dict])

    • days (pulumi.Input[float])

    • enabled (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.monitoring.GetActionGroupResult(email_receivers=None, enabled=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, webhook_receivers=None, id=None)

A collection of values returned by getActionGroup.

email_receivers = None

One or more email_receiver blocks as defined below.

enabled = None

Whether this action group is enabled.

name = None

The name of the webhook receiver.

short_name = None

The short name of the action group.

sms_receivers = None

One or more sms_receiver blocks as defined below.

webhook_receivers = None

One or more webhook_receiver blocks as defined below.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.monitoring.GetDiagnosticCategoriesResult(logs=None, metrics=None, resource_id=None, id=None)

A collection of values returned by getDiagnosticCategories.

logs = None

A list of the Log Categories supported for this Resource.

metrics = None

A list of the Metric Categories supported for this Resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.monitoring.GetLogProfileResult(categories=None, locations=None, name=None, retention_policy=None, servicebus_rule_id=None, storage_account_id=None, id=None)

A collection of values returned by getLogProfile.

categories = None

List of categories of the logs.

locations = None

List of regions for which Activity Log events are stored or streamed.

servicebus_rule_id = None

The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to.

storage_account_id = None

The resource id of the storage account in which the Activity Log is stored.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.monitoring.LogProfile(resource_name, opts=None, categories=None, locations=None, name=None, retention_policy=None, servicebus_rule_id=None, storage_account_id=None, __props__=None, __name__=None, __opts__=None)

Manages a Log Profile. A Log Profile configures how Activity Logs are exported.

NOTE: It’s only possible to configure one Log Profile per Subscription. If you are trying to create more than one Log Profile, an error with StatusCode=409 will occur.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • categories (pulumi.Input[list]) – List of categories of the logs.

  • locations (pulumi.Input[list]) – List of regions for which Activity Log events are stored or streamed.

  • name (pulumi.Input[str]) – The name of the Log Profile. Changing this forces a new resource to be created.

  • retention_policy (pulumi.Input[dict]) – A retention_policy block as documented below. A retention policy for how long Activity Logs are retained in the storage account.

  • servicebus_rule_id (pulumi.Input[str]) – The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of storage_account_id or servicebus_rule_id must be set.

  • storage_account_id (pulumi.Input[str]) – The resource ID of the storage account in which the Activity Log is stored. At least one of storage_account_id or servicebus_rule_id must be set.

The retention_policy object supports the following:

  • days (pulumi.Input[float])

  • enabled (pulumi.Input[bool])

categories = None

List of categories of the logs.

locations = None

List of regions for which Activity Log events are stored or streamed.

name = None

The name of the Log Profile. Changing this forces a new resource to be created.

retention_policy = None

A retention_policy block as documented below. A retention policy for how long Activity Logs are retained in the storage account.

  • days (float)

  • enabled (bool)

servicebus_rule_id = None

The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of storage_account_id or servicebus_rule_id must be set.

storage_account_id = None

The resource ID of the storage account in which the Activity Log is stored. At least one of storage_account_id or servicebus_rule_id must be set.

static get(resource_name, id, opts=None, categories=None, locations=None, name=None, retention_policy=None, servicebus_rule_id=None, storage_account_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • categories (pulumi.Input[list]) – List of categories of the logs.

  • locations (pulumi.Input[list]) – List of regions for which Activity Log events are stored or streamed.

  • name (pulumi.Input[str]) – The name of the Log Profile. Changing this forces a new resource to be created.

  • retention_policy (pulumi.Input[dict]) – A retention_policy block as documented below. A retention policy for how long Activity Logs are retained in the storage account.

  • servicebus_rule_id (pulumi.Input[str]) – The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of storage_account_id or servicebus_rule_id must be set.

  • storage_account_id (pulumi.Input[str]) – The resource ID of the storage account in which the Activity Log is stored. At least one of storage_account_id or servicebus_rule_id must be set.

The retention_policy object supports the following:

  • days (pulumi.Input[float])

  • enabled (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.monitoring.MetricAlert(resource_name, opts=None, actions=None, auto_mitigate=None, criterias=None, description=None, enabled=None, frequency=None, name=None, resource_group_name=None, scopes=None, severity=None, tags=None, window_size=None, __props__=None, __name__=None, __opts__=None)

Manages a Metric Alert within Azure Monitor.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – One or more action blocks as defined below.

  • auto_mitigate (pulumi.Input[bool]) – Should the alerts in this Metric Alert be auto resolved? Defaults to false.

  • criterias (pulumi.Input[list]) – One or more criteria blocks as defined below.

  • description (pulumi.Input[str]) – The description of this Metric Alert.

  • enabled (pulumi.Input[bool]) – Should this Metric Alert be enabled? Defaults to true.

  • frequency (pulumi.Input[str]) – The evaluation frequency of this Metric Alert, represented in ISO 8601 duration format. Possible values are PT1M, PT5M, PT15M, PT30M and PT1H. Defaults to PT1M.

  • name (pulumi.Input[str]) – The name of the Metric Alert. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Metric Alert instance.

  • scopes (pulumi.Input[str]) – The resource ID at which the metric criteria should be applied.

  • severity (pulumi.Input[float]) – The severity of this Metric Alert. Possible values are 0, 1, 2, 3 and 4. Defaults to 3.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • window_size (pulumi.Input[str]) – The period of time that is used to monitor alert activity, represented in ISO 8601 duration format. This value must be greater than frequency. Possible values are PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H and P1D. Defaults to PT5M.

The actions object supports the following:

  • actionGroupId (pulumi.Input[str])

  • webhookProperties (pulumi.Input[dict])

The criterias object supports the following:

  • aggregation (pulumi.Input[str])

  • dimensions (pulumi.Input[list])

    • name (pulumi.Input[str]) - The name of the Metric Alert. Changing this forces a new resource to be created.

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • metric_name (pulumi.Input[str])

  • metricNamespace (pulumi.Input[str])

  • operator (pulumi.Input[str])

  • threshold (pulumi.Input[float])

actions = None

One or more action blocks as defined below.

  • actionGroupId (str)

  • webhookProperties (dict)

auto_mitigate = None

Should the alerts in this Metric Alert be auto resolved? Defaults to false.

criterias = None

One or more criteria blocks as defined below.

  • aggregation (str)

  • dimensions (list)

    • name (str) - The name of the Metric Alert. Changing this forces a new resource to be created.

    • operator (str)

    • values (list)

  • metric_name (str)

  • metricNamespace (str)

  • operator (str)

  • threshold (float)

description = None

The description of this Metric Alert.

enabled = None

Should this Metric Alert be enabled? Defaults to true.

frequency = None

The evaluation frequency of this Metric Alert, represented in ISO 8601 duration format. Possible values are PT1M, PT5M, PT15M, PT30M and PT1H. Defaults to PT1M.

name = None

The name of the Metric Alert. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Metric Alert instance.

scopes = None

The resource ID at which the metric criteria should be applied.

severity = None

The severity of this Metric Alert. Possible values are 0, 1, 2, 3 and 4. Defaults to 3.

tags = None

A mapping of tags to assign to the resource.

window_size = None

The period of time that is used to monitor alert activity, represented in ISO 8601 duration format. This value must be greater than frequency. Possible values are PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H and P1D. Defaults to PT5M.

static get(resource_name, id, opts=None, actions=None, auto_mitigate=None, criterias=None, description=None, enabled=None, frequency=None, name=None, resource_group_name=None, scopes=None, severity=None, tags=None, window_size=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – One or more action blocks as defined below.

  • auto_mitigate (pulumi.Input[bool]) – Should the alerts in this Metric Alert be auto resolved? Defaults to false.

  • criterias (pulumi.Input[list]) – One or more criteria blocks as defined below.

  • description (pulumi.Input[str]) – The description of this Metric Alert.

  • enabled (pulumi.Input[bool]) – Should this Metric Alert be enabled? Defaults to true.

  • frequency (pulumi.Input[str]) – The evaluation frequency of this Metric Alert, represented in ISO 8601 duration format. Possible values are PT1M, PT5M, PT15M, PT30M and PT1H. Defaults to PT1M.

  • name (pulumi.Input[str]) – The name of the Metric Alert. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Metric Alert instance.

  • scopes (pulumi.Input[str]) – The resource ID at which the metric criteria should be applied.

  • severity (pulumi.Input[float]) – The severity of this Metric Alert. Possible values are 0, 1, 2, 3 and 4. Defaults to 3.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • window_size (pulumi.Input[str]) – The period of time that is used to monitor alert activity, represented in ISO 8601 duration format. This value must be greater than frequency. Possible values are PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H and P1D. Defaults to PT5M.

The actions object supports the following:

  • actionGroupId (pulumi.Input[str])

  • webhookProperties (pulumi.Input[dict])

The criterias object supports the following:

  • aggregation (pulumi.Input[str])

  • dimensions (pulumi.Input[list])

    • name (pulumi.Input[str]) - The name of the Metric Alert. Changing this forces a new resource to be created.

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • metric_name (pulumi.Input[str])

  • metricNamespace (pulumi.Input[str])

  • operator (pulumi.Input[str])

  • threshold (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.monitoring.MetricAlertRule(resource_name, opts=None, aggregation=None, description=None, email_action=None, enabled=None, location=None, metric_name=None, name=None, operator=None, period=None, resource_group_name=None, resource_id=None, tags=None, threshold=None, webhook_action=None, __props__=None, __name__=None, __opts__=None)

Manages a metric-based alert rule in Azure Monitor.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aggregation (pulumi.Input[str]) – Defines how the metric data is combined over time. Possible values are Average, Minimum, Maximum, Total, and Last.

  • description (pulumi.Input[str]) – A verbose description of the alert rule that will be included in the alert email.

  • email_action (pulumi.Input[dict]) – A email_action block as defined below.

  • enabled (pulumi.Input[bool]) – If true, the alert rule is enabled. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • metric_name (pulumi.Input[str]) – The metric that defines what the rule monitors.

  • name (pulumi.Input[str]) – Specifies the name of the alert rule. Changing this forces a new resource to be created.

  • operator (pulumi.Input[str]) – The operator used to compare the metric data and the threshold. Possible values are GreaterThan, GreaterThanOrEqual, LessThan, and LessThanOrEqual.

  • period (pulumi.Input[str]) –

    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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The ID of the resource monitored by the alert rule.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

  • threshold (pulumi.Input[float]) – The threshold value that activates the alert.

  • webhook_action (pulumi.Input[dict]) – A webhook_action block as defined below.

The email_action object supports the following:

  • customEmails (pulumi.Input[list]) - A list of email addresses to be notified when the alert is triggered.

  • sendToServiceOwners (pulumi.Input[bool]) - If true, the administrators (service and co-administrators) of the subscription are notified when the alert is triggered. Defaults to false.

The webhook_action object supports the following:

  • properties (pulumi.Input[dict]) - A dictionary of custom properties to include with the webhook POST operation payload.

  • service_uri (pulumi.Input[str]) - The service uri of the webhook to POST the notification when the alert is triggered.

aggregation = None

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

description = None

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

email_action = None

A email_action block as defined below.

  • customEmails (list) - A list of email addresses to be notified when the alert is triggered.

  • sendToServiceOwners (bool) - If true, the administrators (service and co-administrators) of the subscription are notified when the alert is triggered. Defaults to false.

enabled = None

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

location = None

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

metric_name = None

The metric that defines what the rule monitors.

name = None

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

operator = None

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

period = None

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.

resource_group_name = None

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

resource_id = None

The ID of the resource monitored by the alert rule.

tags = None

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

threshold = None

The threshold value that activates the alert.

webhook_action = None

A webhook_action block as defined below.

  • properties (dict) - A dictionary of custom properties to include with the webhook POST operation payload.

  • service_uri (str) - The service uri of the webhook to POST the notification when the alert is triggered.

static get(resource_name, id, opts=None, aggregation=None, description=None, email_action=None, enabled=None, location=None, metric_name=None, name=None, operator=None, period=None, resource_group_name=None, resource_id=None, tags=None, threshold=None, webhook_action=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aggregation (pulumi.Input[str]) – Defines how the metric data is combined over time. Possible values are Average, Minimum, Maximum, Total, and Last.

  • description (pulumi.Input[str]) – A verbose description of the alert rule that will be included in the alert email.

  • email_action (pulumi.Input[dict]) – A email_action block as defined below.

  • enabled (pulumi.Input[bool]) – If true, the alert rule is enabled. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • metric_name (pulumi.Input[str]) – The metric that defines what the rule monitors.

  • name (pulumi.Input[str]) – Specifies the name of the alert rule. Changing this forces a new resource to be created.

  • operator (pulumi.Input[str]) – The operator used to compare the metric data and the threshold. Possible values are GreaterThan, GreaterThanOrEqual, LessThan, and LessThanOrEqual.

  • period (pulumi.Input[str]) –

    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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.

  • resource_id (pulumi.Input[str]) – The ID of the resource monitored by the alert rule.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

  • threshold (pulumi.Input[float]) – The threshold value that activates the alert.

  • webhook_action (pulumi.Input[dict]) – A webhook_action block as defined below.

The email_action object supports the following:

  • customEmails (pulumi.Input[list]) - A list of email addresses to be notified when the alert is triggered.

  • sendToServiceOwners (pulumi.Input[bool]) - If true, the administrators (service and co-administrators) of the subscription are notified when the alert is triggered. Defaults to false.

The webhook_action object supports the following:

  • properties (pulumi.Input[dict]) - A dictionary of custom properties to include with the webhook POST operation payload.

  • service_uri (pulumi.Input[str]) - The service uri of the webhook to POST the notification when the alert is triggered.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.monitoring.get_action_group(name=None, resource_group_name=None, opts=None)

Use this data source to access the properties of an Action Group.

Parameters
  • name (str) – Specifies the name of the Action Group.

  • resource_group_name (str) – Specifies the name of the resource group the Action Group is located in.

pulumi_azure.monitoring.get_diagnostic_categories(resource_id=None, opts=None)

Use this data source to access information about the Monitor Diagnostics Categories supported by an existing Resource.

Parameters

resource_id (str) – The ID of an existing Resource which Monitor Diagnostics Categories should be retrieved for.

pulumi_azure.monitoring.get_log_profile(name=None, opts=None)

Use this data source to access the properties of a Log Profile.

Parameters

name (str) – Specifies the Name of the Log Profile.