This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

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, arm_role_receivers=None, automation_runbook_receivers=None, azure_app_push_receivers=None, azure_function_receivers=None, email_receivers=None, enabled=None, itsm_receivers=None, logic_app_receivers=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, tags=None, voice_receivers=None, webhook_receivers=None, __props__=None, __name__=None, __opts__=None)

Manages an Action Group within Azure Monitor.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_action_group = azure.monitoring.ActionGroup("exampleActionGroup",
    resource_group_name=example_resource_group.name,
    short_name="p0action",
    arm_role_receiver=[{
        "name": "armroleaction",
        "roleId": "de139f84-1756-47ae-9be6-808fbbe84772",
        "useCommonAlertSchema": True,
    }],
    automation_runbook_receiver=[{
        "name": "action_name_1",
        "automationAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-runbooks/providers/microsoft.automation/automationaccounts/aaa001",
        "runbook_name": "my runbook",
        "webhookResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-runbooks/providers/microsoft.automation/automationaccounts/aaa001/webhooks/webhook_alert",
        "isGlobalRunbook": True,
        "service_uri": "https://s13events.azure-automation.net/webhooks?token=randomtoken",
        "useCommonAlertSchema": True,
    }],
    azure_app_push_receiver=[{
        "name": "pushtoadmin",
        "email_address": "admin@contoso.com",
    }],
    azure_function_receiver=[{
        "name": "funcaction",
        "functionAppResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-funcapp/providers/Microsoft.Web/sites/funcapp",
        "functionName": "myfunc",
        "httpTriggerUrl": "https://example.com/trigger",
        "useCommonAlertSchema": True,
    }],
    email_receiver=[
        {
            "name": "sendtoadmin",
            "email_address": "admin@contoso.com",
        },
        {
            "name": "sendtodevops",
            "email_address": "devops@contoso.com",
            "useCommonAlertSchema": True,
        },
    ],
    itsm_receiver=[{
        "name": "createorupdateticket",
        "workspace_id": "6eee3a18-aac3-40e4-b98e-1f309f329816",
        "connectionId": "53de6956-42b4-41ba-be3c-b154cdf17b13",
        "ticketConfiguration": "{}",
        "region": "southcentralus",
    }],
    logic_app_receiver=[{
        "name": "logicappaction",
        "resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-logicapp/providers/Microsoft.Logic/workflows/logicapp",
        "callbackUrl": "https://logicapptriggerurl/...",
        "useCommonAlertSchema": True,
    }],
    sms_receiver=[{
        "name": "oncallmsg",
        "countryCode": "1",
        "phoneNumber": "1231231234",
    }],
    voice_receiver=[{
        "name": "remotesupport",
        "countryCode": "86",
        "phoneNumber": "13888888888",
    }],
    webhook_receiver=[{
        "name": "callmyapiaswell",
        "service_uri": "http://example.com/alert",
        "useCommonAlertSchema": True,
    }])
Parameters
  • resource_name (str) – The name of the resource.

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

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

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

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

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

  • 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.

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

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

  • name (pulumi.Input[str]) – The name of the Action Group. 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 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.

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

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

The arm_role_receivers object supports the following:

  • name (pulumi.Input[str]) - The name of the ARM role receiver.

  • roleId (pulumi.Input[str]) - The arm role id.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

The automation_runbook_receivers object supports the following:

  • automationAccountId (pulumi.Input[str]) - The automation account ID which holds this runbook and authenticates to Azure resources.

  • isGlobalRunbook (pulumi.Input[bool]) - Indicates whether this instance is global runbook.

  • name (pulumi.Input[str]) - The name of the automation runbook receiver.

  • runbook_name (pulumi.Input[str]) - The name for this runbook.

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

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

  • webhookResourceId (pulumi.Input[str]) - The resource id for webhook linked to this runbook.

The azure_app_push_receivers object supports the following:

  • email_address (pulumi.Input[str]) - The email address of the user signed into the mobile app who will receive push notifications from this receiver.

  • name (pulumi.Input[str]) - The name of the Azure app push receiver.

The azure_function_receivers object supports the following:

  • functionAppResourceId (pulumi.Input[str]) - The Azure resource ID of the function app.

  • functionName (pulumi.Input[str]) - The function name in the function app.

  • httpTriggerUrl (pulumi.Input[str]) - The http trigger url where http request sent to.

  • name (pulumi.Input[str]) - The name of the Azure Function receiver.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

The email_receivers object supports the following:

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

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

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

The itsm_receivers object supports the following:

  • connectionId (pulumi.Input[str]) - The unique connection identifier of the ITSM connection.

  • name (pulumi.Input[str]) - The name of the ITSM receiver.

  • region (pulumi.Input[str]) - The region of the workspace.

  • ticketConfiguration (pulumi.Input[str]) - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

  • workspace_id (pulumi.Input[str]) - The Azure Log Analytics workspace ID where this connection is defined.

The logic_app_receivers object supports the following:

  • callbackUrl (pulumi.Input[str]) - The callback url where http request sent to.

  • name (pulumi.Input[str]) - The name of the logic app receiver.

  • resource_id (pulumi.Input[str]) - The Azure resource ID of the logic app.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

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 SMS 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 voice_receivers object supports the following:

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

  • name (pulumi.Input[str]) - The name of the voice receiver.

  • phoneNumber (pulumi.Input[str]) - The phone number of the voice 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.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

arm_role_receivers: pulumi.Output[list] = None

One or more arm_role_receiver blocks as defined below.

  • name (str) - The name of the ARM role receiver.

  • roleId (str) - The arm role id.

  • useCommonAlertSchema (bool) - Enables or disables the common alert schema.

automation_runbook_receivers: pulumi.Output[list] = None

One or more automation_runbook_receiver blocks as defined below.

  • automationAccountId (str) - The automation account ID which holds this runbook and authenticates to Azure resources.

  • isGlobalRunbook (bool) - Indicates whether this instance is global runbook.

  • name (str) - The name of the automation runbook receiver.

  • runbook_name (str) - The name for this runbook.

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

  • useCommonAlertSchema (bool) - Enables or disables the common alert schema.

  • webhookResourceId (str) - The resource id for webhook linked to this runbook.

azure_app_push_receivers: pulumi.Output[list] = None

One or more azure_app_push_receiver blocks as defined below.

  • email_address (str) - The email address of the user signed into the mobile app who will receive push notifications from this receiver.

  • name (str) - The name of the Azure app push receiver.

azure_function_receivers: pulumi.Output[list] = None

One or more azure_function_receiver blocks as defined below.

  • functionAppResourceId (str) - The Azure resource ID of the function app.

  • functionName (str) - The function name in the function app.

  • httpTriggerUrl (str) - The http trigger url where http request sent to.

  • name (str) - The name of the Azure Function receiver.

  • useCommonAlertSchema (bool) - Enables or disables the common alert schema.

email_receivers: pulumi.Output[list] = None

One or more email_receiver blocks as defined below.

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

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

  • useCommonAlertSchema (bool) - Enables or disables the common alert schema.

enabled: pulumi.Output[bool] = 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.

itsm_receivers: pulumi.Output[list] = None

One or more itsm_receiver blocks as defined below.

  • connectionId (str) - The unique connection identifier of the ITSM connection.

  • name (str) - The name of the ITSM receiver.

  • region (str) - The region of the workspace.

  • ticketConfiguration (str) - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

  • workspace_id (str) - The Azure Log Analytics workspace ID where this connection is defined.

logic_app_receivers: pulumi.Output[list] = None

One or more logic_app_receiver blocks as defined below.

  • callbackUrl (str) - The callback url where http request sent to.

  • name (str) - The name of the logic app receiver.

  • resource_id (str) - The Azure resource ID of the logic app.

  • useCommonAlertSchema (bool) - Enables or disables the common alert schema.

name: pulumi.Output[str] = None

The name of the Action Group. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None

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

short_name: pulumi.Output[str] = None

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

sms_receivers: pulumi.Output[list] = 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 SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.

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

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

voice_receivers: pulumi.Output[list] = None

One or more voice_receiver blocks as defined below.

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

  • name (str) - The name of the voice receiver.

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

webhook_receivers: pulumi.Output[list] = 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.

  • useCommonAlertSchema (bool) - Enables or disables the common alert schema.

static get(resource_name, id, opts=None, arm_role_receivers=None, automation_runbook_receivers=None, azure_app_push_receivers=None, azure_function_receivers=None, email_receivers=None, enabled=None, itsm_receivers=None, logic_app_receivers=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, tags=None, voice_receivers=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.

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

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

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

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

  • 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.

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

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

  • name (pulumi.Input[str]) – The name of the Action Group. 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 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.

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

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

The arm_role_receivers object supports the following:

  • name (pulumi.Input[str]) - The name of the ARM role receiver.

  • roleId (pulumi.Input[str]) - The arm role id.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

The automation_runbook_receivers object supports the following:

  • automationAccountId (pulumi.Input[str]) - The automation account ID which holds this runbook and authenticates to Azure resources.

  • isGlobalRunbook (pulumi.Input[bool]) - Indicates whether this instance is global runbook.

  • name (pulumi.Input[str]) - The name of the automation runbook receiver.

  • runbook_name (pulumi.Input[str]) - The name for this runbook.

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

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

  • webhookResourceId (pulumi.Input[str]) - The resource id for webhook linked to this runbook.

The azure_app_push_receivers object supports the following:

  • email_address (pulumi.Input[str]) - The email address of the user signed into the mobile app who will receive push notifications from this receiver.

  • name (pulumi.Input[str]) - The name of the Azure app push receiver.

The azure_function_receivers object supports the following:

  • functionAppResourceId (pulumi.Input[str]) - The Azure resource ID of the function app.

  • functionName (pulumi.Input[str]) - The function name in the function app.

  • httpTriggerUrl (pulumi.Input[str]) - The http trigger url where http request sent to.

  • name (pulumi.Input[str]) - The name of the Azure Function receiver.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

The email_receivers object supports the following:

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

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

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

The itsm_receivers object supports the following:

  • connectionId (pulumi.Input[str]) - The unique connection identifier of the ITSM connection.

  • name (pulumi.Input[str]) - The name of the ITSM receiver.

  • region (pulumi.Input[str]) - The region of the workspace.

  • ticketConfiguration (pulumi.Input[str]) - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

  • workspace_id (pulumi.Input[str]) - The Azure Log Analytics workspace ID where this connection is defined.

The logic_app_receivers object supports the following:

  • callbackUrl (pulumi.Input[str]) - The callback url where http request sent to.

  • name (pulumi.Input[str]) - The name of the logic app receiver.

  • resource_id (pulumi.Input[str]) - The Azure resource ID of the logic app.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

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 SMS 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 voice_receivers object supports the following:

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

  • name (pulumi.Input[str]) - The name of the voice receiver.

  • phoneNumber (pulumi.Input[str]) - The phone number of the voice 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.

  • useCommonAlertSchema (pulumi.Input[bool]) - Enables or disables the common alert schema.

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.ActionRuleActionGroup(resource_name, opts=None, action_group_id=None, condition=None, description=None, enabled=None, name=None, resource_group_name=None, scope=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Monitor Action Rule which type is action group.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_action_group = azure.monitoring.ActionGroup("exampleActionGroup",
    resource_group_name=example_resource_group.name,
    short_name="exampleactiongroup")
example_action_rule_action_group = azure.monitoring.ActionRuleActionGroup("exampleActionRuleActionGroup",
    resource_group_name=example_resource_group.name,
    action_group_id=example_action_group.id,
    scope={
        "type": "ResourceGroup",
        "resourceIds": [example_resource_group.id],
    },
    tags={
        "foo": "bar",
    })
Parameters
  • resource_name (str) – The name of the resource.

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

  • action_group_id (pulumi.Input[str]) – Specifies the resource id of monitor action group.

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

  • description (pulumi.Input[str]) – Specifies a description for the Action Rule.

  • enabled (pulumi.Input[bool]) – Is the Action Rule enabled? Defaults to true.

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

  • resource_group_name (pulumi.Input[str]) – Specifies the name of the resource group in which the Monitor Action Rule should exist. Changing this forces a new resource to be created.

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

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

The condition object supports the following:

  • alertContext (pulumi.Input[dict]) - A alert_context block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • alertRuleId (pulumi.Input[dict]) - A alert_rule_id block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • description (pulumi.Input[dict]) - A description block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • monitor (pulumi.Input[dict]) - A monitor block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Fired and Resolved.

  • monitorService (pulumi.Input[dict]) - A monitor_service as block defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

  • severity (pulumi.Input[dict]) - A severity block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equalsand NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

  • targetResourceType (pulumi.Input[dict]) - A target_resource_type block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. The values should be valid resource types.

The scope object supports the following:

  • resourceIds (pulumi.Input[list]) - A list of resource IDs of the given scope type which will be the target of action rule.

  • type (pulumi.Input[str]) - Specifies the type of target scope. Possible values are ResourceGroup and Resource.

action_group_id: pulumi.Output[str] = None

Specifies the resource id of monitor action group.

condition: pulumi.Output[dict] = None

A condition block as defined below.

  • alertContext (dict) - A alert_context block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (list) - A list of values to match for a given condition.

  • alertRuleId (dict) - A alert_rule_id block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (list) - A list of values to match for a given condition.

  • description (dict) - A description block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (list) - A list of values to match for a given condition.

  • monitor (dict) - A monitor block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (list) - A list of values to match for a given condition. Possible values are Fired and Resolved.

  • monitorService (dict) - A monitor_service as block defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (list) - A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

  • severity (dict) - A severity block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equalsand NotEquals.

    • values (list) - A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

  • targetResourceType (dict) - A target_resource_type block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (list) - A list of values to match for a given condition. The values should be valid resource types.

description: pulumi.Output[str] = None

Specifies a description for the Action Rule.

enabled: pulumi.Output[bool] = None

Is the Action Rule enabled? Defaults to true.

name: pulumi.Output[str] = None

Specifies the name of the Monitor Action Rule. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None

Specifies the name of the resource group in which the Monitor Action Rule should exist. Changing this forces a new resource to be created.

scope: pulumi.Output[dict] = None

A scope block as defined below.

  • resourceIds (list) - A list of resource IDs of the given scope type which will be the target of action rule.

  • type (str) - Specifies the type of target scope. Possible values are ResourceGroup and Resource.

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, action_group_id=None, condition=None, description=None, enabled=None, name=None, resource_group_name=None, scope=None, tags=None)

Get an existing ActionRuleActionGroup 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.

  • action_group_id (pulumi.Input[str]) – Specifies the resource id of monitor action group.

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

  • description (pulumi.Input[str]) – Specifies a description for the Action Rule.

  • enabled (pulumi.Input[bool]) – Is the Action Rule enabled? Defaults to true.

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

  • resource_group_name (pulumi.Input[str]) – Specifies the name of the resource group in which the Monitor Action Rule should exist. Changing this forces a new resource to be created.

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

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

The condition object supports the following:

  • alertContext (pulumi.Input[dict]) - A alert_context block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • alertRuleId (pulumi.Input[dict]) - A alert_rule_id block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • description (pulumi.Input[dict]) - A description block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • monitor (pulumi.Input[dict]) - A monitor block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Fired and Resolved.

  • monitorService (pulumi.Input[dict]) - A monitor_service as block defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

  • severity (pulumi.Input[dict]) - A severity block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equalsand NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

  • targetResourceType (pulumi.Input[dict]) - A target_resource_type block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. The values should be valid resource types.

The scope object supports the following:

  • resourceIds (pulumi.Input[list]) - A list of resource IDs of the given scope type which will be the target of action rule.

  • type (pulumi.Input[str]) - Specifies the type of target scope. Possible values are ResourceGroup and Resource.

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.ActionRuleSuppression(resource_name, opts=None, condition=None, description=None, enabled=None, name=None, resource_group_name=None, scope=None, suppression=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Monitor Action Rule which type is suppression.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_action_rule_suppression = azure.monitoring.ActionRuleSuppression("exampleActionRuleSuppression",
    resource_group_name=example_resource_group.name,
    scope={
        "type": "ResourceGroup",
        "resourceIds": [example_resource_group.id],
    },
    suppression={
        "recurrence_type": "Weekly",
        "schedule": {
            "startDateUtc": "2019-01-01T01:02:03Z",
            "endDateUtc": "2019-01-03T15:02:07Z",
            "recurrenceWeeklies": [
                "Sunday",
                "Monday",
                "Friday",
                "Saturday",
            ],
        },
    },
    tags={
        "foo": "bar",
    })
Parameters
  • resource_name (str) – The name of the resource.

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

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

  • description (pulumi.Input[str]) – Specifies a description for the Action Rule.

  • enabled (pulumi.Input[bool]) – Is the Action Rule enabled? Defaults to true.

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

  • resource_group_name (pulumi.Input[str]) – Specifies the name of the resource group in which the Monitor Action Rule should exist. Changing this forces a new resource to be created.

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

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

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

The condition object supports the following:

  • alertContext (pulumi.Input[dict]) - A alert_context block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • alertRuleId (pulumi.Input[dict]) - A alert_rule_id block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • description (pulumi.Input[dict]) - A description block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • monitor (pulumi.Input[dict]) - A monitor block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Fired and Resolved.

  • monitorService (pulumi.Input[dict]) - A monitor_service as block defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

  • severity (pulumi.Input[dict]) - A severity block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equalsand NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

  • targetResourceType (pulumi.Input[dict]) - A target_resource_type block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. The values should be valid resource types.

The scope object supports the following:

  • resourceIds (pulumi.Input[list]) - A list of resource IDs of the given scope type which will be the target of action rule.

  • type (pulumi.Input[str]) - Specifies the type of target scope. Possible values are ResourceGroup and Resource.

The suppression object supports the following:

  • recurrence_type (pulumi.Input[str]) - Specifies the type of suppression. Possible values are Always, Daily, Monthly, Once, and Weekly.

  • schedule (pulumi.Input[dict]) - A schedule block as defined below. Required if recurrence_type is Daily, Monthly, Once or Weekly.

    • endDateUtc (pulumi.Input[str]) - specifies the recurrence UTC end datetime (Y-m-d’T’H:M:S’Z’).

    • recurrenceMonthlies (pulumi.Input[list]) - specifies the list of dayOfMonth to recurrence. Possible values are between 1 - 31. Required if recurrence_type is Monthly.

    • recurrenceWeeklies (pulumi.Input[list]) - specifies the list of dayOfWeek to recurrence. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    • startDateUtc (pulumi.Input[str]) - specifies the recurrence UTC start datetime (Y-m-d’T’H:M:S’Z’).

condition: pulumi.Output[dict] = None

A condition block as defined below.

  • alertContext (dict) - A alert_context block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (list) - A list of values to match for a given condition.

  • alertRuleId (dict) - A alert_rule_id block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (list) - A list of values to match for a given condition.

  • description (dict) - A description block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (list) - A list of values to match for a given condition.

  • monitor (dict) - A monitor block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (list) - A list of values to match for a given condition. Possible values are Fired and Resolved.

  • monitorService (dict) - A monitor_service as block defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (list) - A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

  • severity (dict) - A severity block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equalsand NotEquals.

    • values (list) - A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

  • targetResourceType (dict) - A target_resource_type block as defined below.

    • operator (str) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (list) - A list of values to match for a given condition. The values should be valid resource types.

description: pulumi.Output[str] = None

Specifies a description for the Action Rule.

enabled: pulumi.Output[bool] = None

Is the Action Rule enabled? Defaults to true.

name: pulumi.Output[str] = None

Specifies the name of the Monitor Action Rule. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None

Specifies the name of the resource group in which the Monitor Action Rule should exist. Changing this forces a new resource to be created.

scope: pulumi.Output[dict] = None

A scope block as defined below.

  • resourceIds (list) - A list of resource IDs of the given scope type which will be the target of action rule.

  • type (str) - Specifies the type of target scope. Possible values are ResourceGroup and Resource.

suppression: pulumi.Output[dict] = None

A suppression block as defined below.

  • recurrence_type (str) - Specifies the type of suppression. Possible values are Always, Daily, Monthly, Once, and Weekly.

  • schedule (dict) - A schedule block as defined below. Required if recurrence_type is Daily, Monthly, Once or Weekly.

    • endDateUtc (str) - specifies the recurrence UTC end datetime (Y-m-d’T’H:M:S’Z’).

    • recurrenceMonthlies (list) - specifies the list of dayOfMonth to recurrence. Possible values are between 1 - 31. Required if recurrence_type is Monthly.

    • recurrenceWeeklies (list) - specifies the list of dayOfWeek to recurrence. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    • startDateUtc (str) - specifies the recurrence UTC start datetime (Y-m-d’T’H:M:S’Z’).

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, condition=None, description=None, enabled=None, name=None, resource_group_name=None, scope=None, suppression=None, tags=None)

Get an existing ActionRuleSuppression 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.

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

  • description (pulumi.Input[str]) – Specifies a description for the Action Rule.

  • enabled (pulumi.Input[bool]) – Is the Action Rule enabled? Defaults to true.

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

  • resource_group_name (pulumi.Input[str]) – Specifies the name of the resource group in which the Monitor Action Rule should exist. Changing this forces a new resource to be created.

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

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

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

The condition object supports the following:

  • alertContext (pulumi.Input[dict]) - A alert_context block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • alertRuleId (pulumi.Input[dict]) - A alert_rule_id block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • description (pulumi.Input[dict]) - A description block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

    • values (pulumi.Input[list]) - A list of values to match for a given condition.

  • monitor (pulumi.Input[dict]) - A monitor block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Fired and Resolved.

  • monitorService (pulumi.Input[dict]) - A monitor_service as block defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

  • severity (pulumi.Input[dict]) - A severity block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equalsand NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

  • targetResourceType (pulumi.Input[dict]) - A target_resource_type block as defined below.

    • operator (pulumi.Input[str]) - The operator for a given condition. Possible values are Equals and NotEquals.

    • values (pulumi.Input[list]) - A list of values to match for a given condition. The values should be valid resource types.

The scope object supports the following:

  • resourceIds (pulumi.Input[list]) - A list of resource IDs of the given scope type which will be the target of action rule.

  • type (pulumi.Input[str]) - Specifies the type of target scope. Possible values are ResourceGroup and Resource.

The suppression object supports the following:

  • recurrence_type (pulumi.Input[str]) - Specifies the type of suppression. Possible values are Always, Daily, Monthly, Once, and Weekly.

  • schedule (pulumi.Input[dict]) - A schedule block as defined below. Required if recurrence_type is Daily, Monthly, Once or Weekly.

    • endDateUtc (pulumi.Input[str]) - specifies the recurrence UTC end datetime (Y-m-d’T’H:M:S’Z’).

    • recurrenceMonthlies (pulumi.Input[list]) - specifies the list of dayOfMonth to recurrence. Possible values are between 1 - 31. Required if recurrence_type is Monthly.

    • recurrenceWeeklies (pulumi.Input[list]) - specifies the list of dayOfWeek to recurrence. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    • startDateUtc (pulumi.Input[str]) - specifies the recurrence UTC start datetime (Y-m-d’T’H:M:S’Z’).

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.

import pulumi
import pulumi_azure as azure

main_resource_group = azure.core.ResourceGroup("mainResourceGroup", location="West US")
main_action_group = azure.monitoring.ActionGroup("mainActionGroup",
    resource_group_name=main_resource_group.name,
    short_name="p0action",
    webhook_receiver=[{
        "name": "callmyapi",
        "service_uri": "http://example.com/alert",
    }])
to_monitor = azure.storage.Account("toMonitor",
    resource_group_name=main_resource_group.name,
    location=main_resource_group.location,
    account_tier="Standard",
    account_replication_type="GRS")
main_activity_log_alert = azure.monitoring.ActivityLogAlert("mainActivityLogAlert",
    resource_group_name=main_resource_group.name,
    scopes=[main_resource_group.id],
    description="This alert will monitor a specific storage account updates.",
    criteria={
        "resource_id": to_monitor.id,
        "operationName": "Microsoft.Storage/storageAccounts/write",
        "category": "Recommendation",
    },
    action=[{
        "action_group_id": main_action_group.id,
        "webhookProperties": {
            "from": "source",
        },
    }])
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:

  • action_group_id (pulumi.Input[str]) - The ID of the Action Group can be sourced from the monitoring.ActionGroup resource.

  • webhookProperties (pulumi.Input[dict]) - The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

The criteria object supports the following:

  • caller (pulumi.Input[str]) - The email address or Azure Active Directory identifier of the user who performed the operation.

  • category (pulumi.Input[str]) - The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

  • level (pulumi.Input[str]) - The severity level of the event. Possible values are Verbose, Informational, Warning, Error, and Critical.

  • operationName (pulumi.Input[str]) - The Resource Manager Role-Based Access Control operation name. Supported operation should be of the form: <resourceProvider>/<resourceType>/<operation>.

  • resourceGroup (pulumi.Input[str]) - The name of resource group monitored by the activity log alert.

  • resource_id (pulumi.Input[str]) - The specific resource monitored by the activity log alert. It should be within one of the scopes.

  • resourceProvider (pulumi.Input[str]) - The name of the resource provider monitored by the activity log alert.

  • resourceType (pulumi.Input[str]) - The resource type monitored by the activity log alert.

  • status (pulumi.Input[str]) - The status of the event. For example, Started, Failed, or Succeeded.

  • subStatus (pulumi.Input[str]) - The sub status of the event.

actions: pulumi.Output[list] = None

One or more action blocks as defined below.

  • action_group_id (str) - The ID of the Action Group can be sourced from the monitoring.ActionGroup resource.

  • webhookProperties (dict) - The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

criteria: pulumi.Output[dict] = None

A criteria block as defined below.

  • caller (str) - The email address or Azure Active Directory identifier of the user who performed the operation.

  • category (str) - The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

  • level (str) - The severity level of the event. Possible values are Verbose, Informational, Warning, Error, and Critical.

  • operationName (str) - The Resource Manager Role-Based Access Control operation name. Supported operation should be of the form: <resourceProvider>/<resourceType>/<operation>.

  • resourceGroup (str) - The name of resource group monitored by the activity log alert.

  • resource_id (str) - The specific resource monitored by the activity log alert. It should be within one of the scopes.

  • resourceProvider (str) - The name of the resource provider monitored by the activity log alert.

  • resourceType (str) - The resource type monitored by the activity log alert.

  • status (str) - The status of the event. For example, Started, Failed, or Succeeded.

  • subStatus (str) - The sub status of the event.

description: pulumi.Output[str] = None

The description of this activity log alert.

enabled: pulumi.Output[bool] = None

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

name: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

scopes: pulumi.Output[list] = 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: pulumi.Output[dict] = 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:

  • action_group_id (pulumi.Input[str]) - The ID of the Action Group can be sourced from the monitoring.ActionGroup resource.

  • webhookProperties (pulumi.Input[dict]) - The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

The criteria object supports the following:

  • caller (pulumi.Input[str]) - The email address or Azure Active Directory identifier of the user who performed the operation.

  • category (pulumi.Input[str]) - The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

  • level (pulumi.Input[str]) - The severity level of the event. Possible values are Verbose, Informational, Warning, Error, and Critical.

  • operationName (pulumi.Input[str]) - The Resource Manager Role-Based Access Control operation name. Supported operation should be of the form: <resourceProvider>/<resourceType>/<operation>.

  • resourceGroup (pulumi.Input[str]) - The name of resource group monitored by the activity log alert.

  • resource_id (pulumi.Input[str]) - The specific resource monitored by the activity log alert. It should be within one of the scopes.

  • resourceProvider (pulumi.Input[str]) - The name of the resource provider monitored by the activity log alert.

  • resourceType (pulumi.Input[str]) - The resource type monitored by the activity log alert.

  • status (pulumi.Input[str]) - The status of the event. For example, Started, Failed, or Succeeded.

  • subStatus (pulumi.Input[str]) - The sub status of the event.

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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_scale_set = azure.compute.ScaleSet("exampleScaleSet")
# ...
example_autoscale_setting = azure.monitoring.AutoscaleSetting("exampleAutoscaleSetting",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    target_resource_id=example_scale_set.id,
    profile=[{
        "name": "defaultProfile",
        "capacity": {
            "default": 1,
            "minimum": 1,
            "maximum": 10,
        },
        "rule": [
            {
                "metric_trigger": {
                    "metricName": "Percentage CPU",
                    "metricResourceId": example_scale_set.id,
                    "timeGrain": "PT1M",
                    "statistic": "Average",
                    "time_window": "PT5M",
                    "timeAggregation": "Average",
                    "operator": "GreaterThan",
                    "threshold": 75,
                },
                "scale_action": {
                    "direction": "Increase",
                    "type": "ChangeCount",
                    "value": "1",
                    "cooldown": "PT1M",
                },
            },
            {
                "metric_trigger": {
                    "metricName": "Percentage CPU",
                    "metricResourceId": example_scale_set.id,
                    "timeGrain": "PT1M",
                    "statistic": "Average",
                    "time_window": "PT5M",
                    "timeAggregation": "Average",
                    "operator": "LessThan",
                    "threshold": 25,
                },
                "scale_action": {
                    "direction": "Decrease",
                    "type": "ChangeCount",
                    "value": "1",
                    "cooldown": "PT1M",
                },
            },
        ],
    }],
    notification={
        "email": {
            "sendToSubscriptionAdministrator": True,
            "sendToSubscriptionCoAdministrator": True,
            "customEmails": ["admin@contoso.com"],
        },
    })
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_scale_set = azure.compute.ScaleSet("exampleScaleSet")
# ...
example_autoscale_setting = azure.monitoring.AutoscaleSetting("exampleAutoscaleSetting",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    target_resource_id=example_scale_set.id,
    profile=[{
        "name": "Weekends",
        "capacity": {
            "default": 1,
            "minimum": 1,
            "maximum": 10,
        },
        "rule": [
            {
                "metric_trigger": {
                    "metricName": "Percentage CPU",
                    "metricResourceId": example_scale_set.id,
                    "timeGrain": "PT1M",
                    "statistic": "Average",
                    "time_window": "PT5M",
                    "timeAggregation": "Average",
                    "operator": "GreaterThan",
                    "threshold": 90,
                },
                "scale_action": {
                    "direction": "Increase",
                    "type": "ChangeCount",
                    "value": "2",
                    "cooldown": "PT1M",
                },
            },
            {
                "metric_trigger": {
                    "metricName": "Percentage CPU",
                    "metricResourceId": example_scale_set.id,
                    "timeGrain": "PT1M",
                    "statistic": "Average",
                    "time_window": "PT5M",
                    "timeAggregation": "Average",
                    "operator": "LessThan",
                    "threshold": 10,
                },
                "scale_action": {
                    "direction": "Decrease",
                    "type": "ChangeCount",
                    "value": "2",
                    "cooldown": "PT1M",
                },
            },
        ],
        "recurrence": {
            "frequency": "Week",
            "timezone": "Pacific Standard Time",
            "days": [
                "Saturday",
                "Sunday",
            ],
            "hours": [12],
            "minutes": [0],
        },
    }],
    notification={
        "email": {
            "sendToSubscriptionAdministrator": True,
            "sendToSubscriptionCoAdministrator": True,
            "customEmails": ["admin@contoso.com"],
        },
    })
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_scale_set = azure.compute.ScaleSet("exampleScaleSet")
# ...
example_autoscale_setting = azure.monitoring.AutoscaleSetting("exampleAutoscaleSetting",
    enabled=True,
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    target_resource_id=example_scale_set.id,
    profile=[{
        "name": "forJuly",
        "capacity": {
            "default": 1,
            "minimum": 1,
            "maximum": 10,
        },
        "rule": [
            {
                "metric_trigger": {
                    "metricName": "Percentage CPU",
                    "metricResourceId": example_scale_set.id,
                    "timeGrain": "PT1M",
                    "statistic": "Average",
                    "time_window": "PT5M",
                    "timeAggregation": "Average",
                    "operator": "GreaterThan",
                    "threshold": 90,
                },
                "scale_action": {
                    "direction": "Increase",
                    "type": "ChangeCount",
                    "value": "2",
                    "cooldown": "PT1M",
                },
            },
            {
                "metric_trigger": {
                    "metricName": "Percentage CPU",
                    "metricResourceId": example_scale_set.id,
                    "timeGrain": "PT1M",
                    "statistic": "Average",
                    "time_window": "PT5M",
                    "timeAggregation": "Average",
                    "operator": "LessThan",
                    "threshold": 10,
                },
                "scale_action": {
                    "direction": "Decrease",
                    "type": "ChangeCount",
                    "value": "2",
                    "cooldown": "PT1M",
                },
            },
        ],
        "fixed_date": {
            "timezone": "Pacific Standard Time",
            "start": "2020-07-01T00:00:00Z",
            "end": "2020-07-31T23:59:59Z",
        },
    }],
    notification={
        "email": {
            "sendToSubscriptionAdministrator": True,
            "sendToSubscriptionCoAdministrator": True,
            "customEmails": ["admin@contoso.com"],
        },
    })
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]) - A email block as defined below.

    • customEmails (pulumi.Input[list]) - Specifies a list of custom email addresses to which the email notifications will be sent.

    • sendToSubscriptionAdministrator (pulumi.Input[bool]) - Should email notifications be sent to the subscription administrator? Defaults to false.

    • sendToSubscriptionCoAdministrator (pulumi.Input[bool]) - Should email notifications be sent to the subscription co-administrator? Defaults to false.

  • webhooks (pulumi.Input[list]) - One or more webhook blocks as defined below.

    • properties (pulumi.Input[dict]) - A map of settings.

    • service_uri (pulumi.Input[str]) - The HTTPS URI which should receive scale notifications.

The profiles object supports the following:

  • capacity (pulumi.Input[dict]) - A capacity block as defined below.

    • default (pulumi.Input[float]) - The number of instances that are available for scaling if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. Valid values are between 0 and 1000.

    • maximum (pulumi.Input[float]) - The maximum number of instances for this resource. Valid values are between 0 and 1000.

    • minimum (pulumi.Input[float]) - The minimum number of instances for this resource. Valid values are between 0 and 1000.

  • fixedDate (pulumi.Input[dict]) - A fixed_date block as defined below. This cannot be specified if a recurrence block is specified.

    • end (pulumi.Input[str]) - Specifies the end date for the profile, formatted as an RFC3339 date string.

    • start (pulumi.Input[str]) - Specifies the start date for the profile, formatted as an RFC3339 date string.

    • timezone (pulumi.Input[str]) - The Time Zone of the start and end times. A list of possible values can be found here. Defaults to UTC.

  • name (pulumi.Input[str]) - Specifies the name of the profile.

  • recurrence (pulumi.Input[dict]) - A recurrence block as defined below. This cannot be specified if a fixed_date block is specified.

    • days (pulumi.Input[list]) - A list of days that this profile takes effect on. Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

    • hours (pulumi.Input[float]) - A list containing a single item, which specifies the Hour interval at which this recurrence should be triggered (in 24-hour time). Possible values are from 0 to 23.

    • minutes (pulumi.Input[float]) - A list containing a single item which specifies the Minute interval at which this recurrence should be triggered.

    • timezone (pulumi.Input[str]) - The Time Zone used for the hours field. A list of possible values can be found here. Defaults to UTC.

  • rules (pulumi.Input[list]) - One or more (up to 10) rule blocks as defined below.

    • metricTrigger (pulumi.Input[dict]) - A metric_trigger block as defined below.

      • metricName (pulumi.Input[str]) - The name of the metric that defines what the rule monitors, such as Percentage CPU for Virtual Machine Scale Sets and CpuPercentage for App Service Plan.

      • metricResourceId (pulumi.Input[str]) - The ID of the Resource which the Rule monitors.

      • operator (pulumi.Input[str]) - Specifies the operator used to compare the metric data and threshold. Possible values are: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual.

      • statistic (pulumi.Input[str]) - Specifies how the metrics from multiple instances are combined. Possible values are Average, Min and Max.

      • threshold (pulumi.Input[float]) - Specifies the threshold of the metric that triggers the scale action.

      • timeAggregation (pulumi.Input[str]) - Specifies how the data that’s collected should be combined over time. Possible values include Average, Count, Maximum, Minimum, Last and Total. Defaults to Average.

      • timeGrain (pulumi.Input[str]) - Specifies the granularity of metrics that the rule monitors, which must be one of the pre-defined values returned from the metric definitions for the metric. This value must be between 1 minute and 12 hours an be formatted as an ISO 8601 string.

      • time_window (pulumi.Input[str]) - Specifies the time range for which data is collected, which must be greater than the delay in metric collection (which varies from resource to resource). This value must be between 5 minutes and 12 hours and be formatted as an ISO 8601 string.

    • scaleAction (pulumi.Input[dict]) - A scale_action block as defined below.

      • cooldown (pulumi.Input[str]) - The amount of time to wait since the last scaling action before this action occurs. Must be between 1 minute and 1 week and formatted as a ISO 8601 string.

      • direction (pulumi.Input[str]) - The scale direction. Possible values are Increase and Decrease.

      • type (pulumi.Input[str]) - The type of action that should occur. Possible values are ChangeCount, ExactCount and PercentChangeCount.

      • value (pulumi.Input[float]) - The number of instances involved in the scaling action. Defaults to 1.

enabled: pulumi.Output[bool] = None

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

location: pulumi.Output[str] = None

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

name: pulumi.Output[str] = None

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

notification: pulumi.Output[dict] = None

Specifies a notification block as defined below.

  • email (dict) - A email block as defined below.

    • customEmails (list) - Specifies a list of custom email addresses to which the email notifications will be sent.

    • sendToSubscriptionAdministrator (bool) - Should email notifications be sent to the subscription administrator? Defaults to false.

    • sendToSubscriptionCoAdministrator (bool) - Should email notifications be sent to the subscription co-administrator? Defaults to false.

  • webhooks (list) - One or more webhook blocks as defined below.

    • properties (dict) - A map of settings.

    • service_uri (str) - The HTTPS URI which should receive scale notifications.

profiles: pulumi.Output[list] = None

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

  • capacity (dict) - A capacity block as defined below.

    • default (float) - The number of instances that are available for scaling if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. Valid values are between 0 and 1000.

    • maximum (float) - The maximum number of instances for this resource. Valid values are between 0 and 1000.

    • minimum (float) - The minimum number of instances for this resource. Valid values are between 0 and 1000.

  • fixedDate (dict) - A fixed_date block as defined below. This cannot be specified if a recurrence block is specified.

    • end (str) - Specifies the end date for the profile, formatted as an RFC3339 date string.

    • start (str) - Specifies the start date for the profile, formatted as an RFC3339 date string.

    • timezone (str) - The Time Zone of the start and end times. A list of possible values can be found here. Defaults to UTC.

  • name (str) - Specifies the name of the profile.

  • recurrence (dict) - A recurrence block as defined below. This cannot be specified if a fixed_date block is specified.

    • days (list) - A list of days that this profile takes effect on. Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

    • hours (float) - A list containing a single item, which specifies the Hour interval at which this recurrence should be triggered (in 24-hour time). Possible values are from 0 to 23.

    • minutes (float) - A list containing a single item which specifies the Minute interval at which this recurrence should be triggered.

    • timezone (str) - The Time Zone used for the hours field. A list of possible values can be found here. Defaults to UTC.

  • rules (list) - One or more (up to 10) rule blocks as defined below.

    • metricTrigger (dict) - A metric_trigger block as defined below.

      • metricName (str) - The name of the metric that defines what the rule monitors, such as Percentage CPU for Virtual Machine Scale Sets and CpuPercentage for App Service Plan.

      • metricResourceId (str) - The ID of the Resource which the Rule monitors.

      • operator (str) - Specifies the operator used to compare the metric data and threshold. Possible values are: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual.

      • statistic (str) - Specifies how the metrics from multiple instances are combined. Possible values are Average, Min and Max.

      • threshold (float) - Specifies the threshold of the metric that triggers the scale action.

      • timeAggregation (str) - Specifies how the data that’s collected should be combined over time. Possible values include Average, Count, Maximum, Minimum, Last and Total. Defaults to Average.

      • timeGrain (str) - Specifies the granularity of metrics that the rule monitors, which must be one of the pre-defined values returned from the metric definitions for the metric. This value must be between 1 minute and 12 hours an be formatted as an ISO 8601 string.

      • time_window (str) - Specifies the time range for which data is collected, which must be greater than the delay in metric collection (which varies from resource to resource). This value must be between 5 minutes and 12 hours and be formatted as an ISO 8601 string.

    • scaleAction (dict) - A scale_action block as defined below.

      • cooldown (str) - The amount of time to wait since the last scaling action before this action occurs. Must be between 1 minute and 1 week and formatted as a ISO 8601 string.

      • direction (str) - The scale direction. Possible values are Increase and Decrease.

      • type (str) - The type of action that should occur. Possible values are ChangeCount, ExactCount and PercentChangeCount.

      • value (float) - The number of instances involved in the scaling action. Defaults to 1.

resource_group_name: pulumi.Output[str] = None

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

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

target_resource_id: pulumi.Output[str] = 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]) - A email block as defined below.

    • customEmails (pulumi.Input[list]) - Specifies a list of custom email addresses to which the email notifications will be sent.

    • sendToSubscriptionAdministrator (pulumi.Input[bool]) - Should email notifications be sent to the subscription administrator? Defaults to false.

    • sendToSubscriptionCoAdministrator (pulumi.Input[bool]) - Should email notifications be sent to the subscription co-administrator? Defaults to false.

  • webhooks (pulumi.Input[list]) - One or more webhook blocks as defined below.

    • properties (pulumi.Input[dict]) - A map of settings.

    • service_uri (pulumi.Input[str]) - The HTTPS URI which should receive scale notifications.

The profiles object supports the following:

  • capacity (pulumi.Input[dict]) - A capacity block as defined below.

    • default (pulumi.Input[float]) - The number of instances that are available for scaling if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. Valid values are between 0 and 1000.

    • maximum (pulumi.Input[float]) - The maximum number of instances for this resource. Valid values are between 0 and 1000.

    • minimum (pulumi.Input[float]) - The minimum number of instances for this resource. Valid values are between 0 and 1000.

  • fixedDate (pulumi.Input[dict]) - A fixed_date block as defined below. This cannot be specified if a recurrence block is specified.

    • end (pulumi.Input[str]) - Specifies the end date for the profile, formatted as an RFC3339 date string.

    • start (pulumi.Input[str]) - Specifies the start date for the profile, formatted as an RFC3339 date string.

    • timezone (pulumi.Input[str]) - The Time Zone of the start and end times. A list of possible values can be found here. Defaults to UTC.

  • name (pulumi.Input[str]) - Specifies the name of the profile.

  • recurrence (pulumi.Input[dict]) - A recurrence block as defined below. This cannot be specified if a fixed_date block is specified.

    • days (pulumi.Input[list]) - A list of days that this profile takes effect on. Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

    • hours (pulumi.Input[float]) - A list containing a single item, which specifies the Hour interval at which this recurrence should be triggered (in 24-hour time). Possible values are from 0 to 23.

    • minutes (pulumi.Input[float]) - A list containing a single item which specifies the Minute interval at which this recurrence should be triggered.

    • timezone (pulumi.Input[str]) - The Time Zone used for the hours field. A list of possible values can be found here. Defaults to UTC.

  • rules (pulumi.Input[list]) - One or more (up to 10) rule blocks as defined below.

    • metricTrigger (pulumi.Input[dict]) - A metric_trigger block as defined below.

      • metricName (pulumi.Input[str]) - The name of the metric that defines what the rule monitors, such as Percentage CPU for Virtual Machine Scale Sets and CpuPercentage for App Service Plan.

      • metricResourceId (pulumi.Input[str]) - The ID of the Resource which the Rule monitors.

      • operator (pulumi.Input[str]) - Specifies the operator used to compare the metric data and threshold. Possible values are: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual.

      • statistic (pulumi.Input[str]) - Specifies how the metrics from multiple instances are combined. Possible values are Average, Min and Max.

      • threshold (pulumi.Input[float]) - Specifies the threshold of the metric that triggers the scale action.

      • timeAggregation (pulumi.Input[str]) - Specifies how the data that’s collected should be combined over time. Possible values include Average, Count, Maximum, Minimum, Last and Total. Defaults to Average.

      • timeGrain (pulumi.Input[str]) - Specifies the granularity of metrics that the rule monitors, which must be one of the pre-defined values returned from the metric definitions for the metric. This value must be between 1 minute and 12 hours an be formatted as an ISO 8601 string.

      • time_window (pulumi.Input[str]) - Specifies the time range for which data is collected, which must be greater than the delay in metric collection (which varies from resource to resource). This value must be between 5 minutes and 12 hours and be formatted as an ISO 8601 string.

    • scaleAction (pulumi.Input[dict]) - A scale_action block as defined below.

      • cooldown (pulumi.Input[str]) - The amount of time to wait since the last scaling action before this action occurs. Must be between 1 minute and 1 week and formatted as a ISO 8601 string.

      • direction (pulumi.Input[str]) - The scale direction. Possible values are Increase and Decrease.

      • type (pulumi.Input[str]) - The type of action that should occur. Possible values are ChangeCount, ExactCount and PercentChangeCount.

      • value (pulumi.Input[float]) - The number of instances involved in the scaling action. Defaults to 1.

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(arm_role_receivers=None, automation_runbook_receivers=None, azure_app_push_receivers=None, azure_function_receivers=None, email_receivers=None, enabled=None, id=None, itsm_receivers=None, logic_app_receivers=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, voice_receivers=None, webhook_receivers=None)
class pulumi_azure.monitoring.AwaitableGetDiagnosticCategoriesResult(id=None, logs=None, metrics=None, resource_id=None)
class pulumi_azure.monitoring.AwaitableGetLogProfileResult(categories=None, id=None, locations=None, name=None, retention_policies=None, servicebus_rule_id=None, storage_account_id=None)
class pulumi_azure.monitoring.AwaitableGetScheduledQueryRulesAlertResult(actions=None, authorized_resource_ids=None, data_source_id=None, description=None, enabled=None, frequency=None, id=None, location=None, name=None, query=None, query_type=None, resource_group_name=None, severity=None, tags=None, throttling=None, time_window=None, triggers=None)
class pulumi_azure.monitoring.AwaitableGetScheduledQueryRulesLogResult(authorized_resource_ids=None, criterias=None, data_source_id=None, description=None, enabled=None, id=None, location=None, name=None, resource_group_name=None, tags=None)
class pulumi_azure.monitoring.DiagnosticSetting(resource_name, opts=None, eventhub_authorization_rule_id=None, eventhub_name=None, log_analytics_destination_type=None, log_analytics_workspace_id=None, logs=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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = example_resource_group.name.apply(lambda name: azure.storage.get_account(name="examplestoracc",
    resource_group_name=name))
example_key_vault = example_resource_group.name.apply(lambda name: azure.keyvault.get_key_vault(name="example-vault",
    resource_group_name=name))
example_diagnostic_setting = azure.monitoring.DiagnosticSetting("exampleDiagnosticSetting",
    target_resource_id=example_key_vault.id,
    storage_account_id=example_account.id,
    log=[{
        "category": "AuditEvent",
        "enabled": False,
        "retention_policy": {
            "enabled": False,
        },
    }],
    metric=[{
        "category": "AllMetrics",
        "retention_policy": {
            "enabled": False,
        },
    }])
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.

  • 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.

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

  • 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]) - The name of a Diagnostic Log Category for this Resource.

  • enabled (pulumi.Input[bool]) - Is this Diagnostic Log enabled? Defaults to true.

  • retention_policy (pulumi.Input[dict]) - A retention_policy block as defined below.

    • days (pulumi.Input[float]) - The number of days for which this Retention Policy should apply.

    • enabled (pulumi.Input[bool]) - Is this Retention Policy enabled?

The metrics object supports the following:

  • category (pulumi.Input[str]) - The name of a Diagnostic Metric Category for this Resource.

  • enabled (pulumi.Input[bool]) - Is this Diagnostic Metric enabled? Defaults to true.

  • retention_policy (pulumi.Input[dict]) - A retention_policy block as defined below.

    • days (pulumi.Input[float]) - The number of days for which this Retention Policy should apply.

    • enabled (pulumi.Input[bool]) - Is this Retention Policy enabled?

eventhub_authorization_rule_id: pulumi.Output[str] = 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: pulumi.Output[str] = None

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

log_analytics_destination_type: pulumi.Output[str] = 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: pulumi.Output[str] = None

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

logs: pulumi.Output[list] = None

One or more log blocks as defined below.

  • category (str) - The name of a Diagnostic Log Category for this Resource.

  • enabled (bool) - Is this Diagnostic Log enabled? Defaults to true.

  • retention_policy (dict) - A retention_policy block as defined below.

    • days (float) - The number of days for which this Retention Policy should apply.

    • enabled (bool) - Is this Retention Policy enabled?

metrics: pulumi.Output[list] = None

One or more metric blocks as defined below.

  • category (str) - The name of a Diagnostic Metric Category for this Resource.

  • enabled (bool) - Is this Diagnostic Metric enabled? Defaults to true.

  • retention_policy (dict) - A retention_policy block as defined below.

    • days (float) - The number of days for which this Retention Policy should apply.

    • enabled (bool) - Is this Retention Policy enabled?

name: pulumi.Output[str] = None

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

storage_account_id: pulumi.Output[str] = 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: pulumi.Output[str] = 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, log_analytics_destination_type=None, log_analytics_workspace_id=None, logs=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.

  • 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.

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

  • 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]) - The name of a Diagnostic Log Category for this Resource.

  • enabled (pulumi.Input[bool]) - Is this Diagnostic Log enabled? Defaults to true.

  • retention_policy (pulumi.Input[dict]) - A retention_policy block as defined below.

    • days (pulumi.Input[float]) - The number of days for which this Retention Policy should apply.

    • enabled (pulumi.Input[bool]) - Is this Retention Policy enabled?

The metrics object supports the following:

  • category (pulumi.Input[str]) - The name of a Diagnostic Metric Category for this Resource.

  • enabled (pulumi.Input[bool]) - Is this Diagnostic Metric enabled? Defaults to true.

  • retention_policy (pulumi.Input[dict]) - A retention_policy block as defined below.

    • days (pulumi.Input[float]) - The number of days for which this Retention Policy should apply.

    • enabled (pulumi.Input[bool]) - Is this Retention Policy enabled?

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(arm_role_receivers=None, automation_runbook_receivers=None, azure_app_push_receivers=None, azure_function_receivers=None, email_receivers=None, enabled=None, id=None, itsm_receivers=None, logic_app_receivers=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, voice_receivers=None, webhook_receivers=None)

A collection of values returned by getActionGroup.

arm_role_receivers = None

One or more arm_role_receiver blocks as defined below.

automation_runbook_receivers = None

One or more automation_runbook_receiver blocks as defined below.

azure_app_push_receivers = None

One or more azure_app_push_receiver blocks as defined below.

azure_function_receivers = None

One or more azure_function_receiver blocks as defined below.

email_receivers = None

One or more email_receiver blocks as defined below.

enabled = None

Whether this action group is enabled.

id = None

The provider-assigned unique ID for this managed resource.

itsm_receivers = None

One or more itsm_receiver blocks as defined below.

logic_app_receivers = None

One or more logic_app_receiver blocks as defined below.

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.

voice_receivers = None

One or more voice_receiver blocks as defined below.

webhook_receivers = None

One or more webhook_receiver blocks as defined below.

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

A collection of values returned by getDiagnosticCategories.

id = None

The provider-assigned unique ID for this managed resource.

logs = None

A list of the Log Categories supported for this Resource.

metrics = None

A list of the Metric Categories supported for this Resource.

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

A collection of values returned by getLogProfile.

categories = None

List of categories of the logs.

id = None

The provider-assigned unique ID for this managed resource.

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.

class pulumi_azure.monitoring.GetScheduledQueryRulesAlertResult(actions=None, authorized_resource_ids=None, data_source_id=None, description=None, enabled=None, frequency=None, id=None, location=None, name=None, query=None, query_type=None, resource_group_name=None, severity=None, tags=None, throttling=None, time_window=None, triggers=None)

A collection of values returned by getScheduledQueryRulesAlert.

actions = None

An action block as defined below.

authorized_resource_ids = None

List of Resource IDs referred into query.

data_source_id = None

The resource URI over which log search query is to be run.

description = None

The description of the scheduled query rule.

enabled = None

Whether this scheduled query rule is enabled.

frequency = None

Frequency at which rule condition should be evaluated.

id = None

The provider-assigned unique ID for this managed resource.

query = None

Log search query.

severity = None

Severity of the alert.

throttling = None

Time for which alerts should be throttled or suppressed.

time_window = None

Time window for which data needs to be fetched for query.

triggers = None

A trigger block as defined below.

class pulumi_azure.monitoring.GetScheduledQueryRulesLogResult(authorized_resource_ids=None, criterias=None, data_source_id=None, description=None, enabled=None, id=None, location=None, name=None, resource_group_name=None, tags=None)

A collection of values returned by getScheduledQueryRulesLog.

criterias = None

A criteria block as defined below.

data_source_id = None

The resource URI over which log search query is to be run.

description = None

The description of the scheduled query rule.

enabled = None

Whether this scheduled query rule is enabled.

id = None

The provider-assigned unique ID for this managed resource.

name = None

Name of the dimension.

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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="GRS")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("exampleEventHubNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    capacity=2)
example_log_profile = azure.monitoring.LogProfile("exampleLogProfile",
    categories=[
        "Action",
        "Delete",
        "Write",
    ],
    locations=[
        "westus",
        "global",
    ],
    servicebus_rule_id=example_event_hub_namespace.id.apply(lambda id: f"{id}/authorizationrules/RootManageSharedAccessKey"),
    storage_account_id=example_account.id,
    retention_policy={
        "enabled": True,
        "days": 7,
    })
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]) - The number of days for the retention policy. Defaults to 0.

  • enabled (pulumi.Input[bool]) - A boolean value to indicate whether the retention policy is enabled.

categories: pulumi.Output[list] = None

List of categories of the logs.

locations: pulumi.Output[list] = None

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

name: pulumi.Output[str] = None

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

retention_policy: pulumi.Output[dict] = None

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

  • days (float) - The number of days for the retention policy. Defaults to 0.

  • enabled (bool) - A boolean value to indicate whether the retention policy is enabled.

servicebus_rule_id: pulumi.Output[str] = 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: pulumi.Output[str] = 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]) - The number of days for the retention policy. Defaults to 0.

  • enabled (pulumi.Input[bool]) - A boolean value to indicate whether the retention policy is enabled.

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.

import pulumi
import pulumi_azure as azure

main_resource_group = azure.core.ResourceGroup("mainResourceGroup", location="West US")
to_monitor = azure.storage.Account("toMonitor",
    resource_group_name=main_resource_group.name,
    location=main_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
main_action_group = azure.monitoring.ActionGroup("mainActionGroup",
    resource_group_name=main_resource_group.name,
    short_name="exampleact",
    webhook_receiver=[{
        "name": "callmyapi",
        "service_uri": "http://example.com/alert",
    }])
example = azure.monitoring.MetricAlert("example",
    resource_group_name=main_resource_group.name,
    scopes=[to_monitor.id],
    description="Action will be triggered when Transactions count is greater than 50.",
    criteria=[{
        "metricNamespace": "Microsoft.Storage/storageAccounts",
        "metricName": "Transactions",
        "aggregation": "Total",
        "operator": "GreaterThan",
        "threshold": 50,
        "dimension": [{
            "name": "ApiName",
            "operator": "Include",
            "values": ["*"],
        }],
    }],
    action=[{
        "action_group_id": main_action_group.id,
    }])
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 true.

  • 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]) – A set of strings of resource IDs 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:

  • action_group_id (pulumi.Input[str]) - The ID of the Action Group can be sourced from the monitoring.ActionGroup resource

  • webhookProperties (pulumi.Input[dict]) - The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

The criterias object supports the following:

  • aggregation (pulumi.Input[str]) - The statistic that runs over the metric values. Possible values are Average, Count, Minimum, Maximum and Total.

  • dimensions (pulumi.Input[list]) - One or more dimension blocks as defined below.

    • name (pulumi.Input[str]) - One of the dimension names.

    • operator (pulumi.Input[str]) - The dimension operator. Possible values are Include and Exclude.

    • values (pulumi.Input[list]) - The list of dimension values.

  • metricName (pulumi.Input[str]) - One of the metric names to be monitored.

  • metricNamespace (pulumi.Input[str]) - One of the metric namespaces to be monitored.

  • operator (pulumi.Input[str]) - The criteria operator. Possible values are Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

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

actions: pulumi.Output[list] = None

One or more action blocks as defined below.

  • action_group_id (str) - The ID of the Action Group can be sourced from the monitoring.ActionGroup resource

  • webhookProperties (dict) - The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

auto_mitigate: pulumi.Output[bool] = None

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

criterias: pulumi.Output[list] = None

One or more criteria blocks as defined below.

  • aggregation (str) - The statistic that runs over the metric values. Possible values are Average, Count, Minimum, Maximum and Total.

  • dimensions (list) - One or more dimension blocks as defined below.

    • name (str) - One of the dimension names.

    • operator (str) - The dimension operator. Possible values are Include and Exclude.

    • values (list) - The list of dimension values.

  • metricName (str) - One of the metric names to be monitored.

  • metricNamespace (str) - One of the metric namespaces to be monitored.

  • operator (str) - The criteria operator. Possible values are Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

  • threshold (float) - The criteria threshold value that activates the alert.

description: pulumi.Output[str] = None

The description of this Metric Alert.

enabled: pulumi.Output[bool] = None

Should this Metric Alert be enabled? Defaults to true.

frequency: pulumi.Output[str] = 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: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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

scopes: pulumi.Output[str] = None

A set of strings of resource IDs at which the metric criteria should be applied.

severity: pulumi.Output[float] = None

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

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

window_size: pulumi.Output[str] = 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 true.

  • 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]) – A set of strings of resource IDs 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:

  • action_group_id (pulumi.Input[str]) - The ID of the Action Group can be sourced from the monitoring.ActionGroup resource

  • webhookProperties (pulumi.Input[dict]) - The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

The criterias object supports the following:

  • aggregation (pulumi.Input[str]) - The statistic that runs over the metric values. Possible values are Average, Count, Minimum, Maximum and Total.

  • dimensions (pulumi.Input[list]) - One or more dimension blocks as defined below.

    • name (pulumi.Input[str]) - One of the dimension names.

    • operator (pulumi.Input[str]) - The dimension operator. Possible values are Include and Exclude.

    • values (pulumi.Input[list]) - The list of dimension values.

  • metricName (pulumi.Input[str]) - One of the metric names to be monitored.

  • metricNamespace (pulumi.Input[str]) - One of the metric namespaces to be monitored.

  • operator (pulumi.Input[str]) - The criteria operator. Possible values are Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

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

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.ScheduledQueryRulesAlert(resource_name, opts=None, action=None, authorized_resource_ids=None, data_source_id=None, description=None, enabled=None, frequency=None, location=None, name=None, query=None, query_type=None, resource_group_name=None, severity=None, tags=None, throttling=None, time_window=None, trigger=None, __props__=None, __name__=None, __opts__=None)

Manages an AlertingAction Scheduled Query Rules resource within Azure Monitor.

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

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

  • action (pulumi.Input[dict]) – An action block as defined below.

  • authorized_resource_ids (pulumi.Input[list]) – List of Resource IDs referred into query.

  • data_source_id (pulumi.Input[str]) – The resource URI over which log search query is to be run.

  • description (pulumi.Input[str]) – The description of the scheduled query rule.

  • enabled (pulumi.Input[bool]) – Whether this scheduled query rule is enabled. Default is true.

  • frequency (pulumi.Input[float]) – Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).

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

  • query (pulumi.Input[str]) – Log search query.

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

  • severity (pulumi.Input[float]) – Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.

  • throttling (pulumi.Input[float]) – Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

  • time_window (pulumi.Input[float]) – Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).

  • trigger (pulumi.Input[dict]) – The condition that results in the alert rule being run.

The action object supports the following:

  • actionGroups (pulumi.Input[list]) - List of action group reference resource IDs.

  • customWebhookPayload (pulumi.Input[str]) - Custom payload to be sent for all webhook payloads in alerting action.

  • emailSubject (pulumi.Input[str]) - Custom subject override for all email ids in Azure action group.

The trigger object supports the following:

  • metricTrigger (pulumi.Input[dict])

    • metricColumn (pulumi.Input[str])

    • metricTriggerType (pulumi.Input[str])

    • operator (pulumi.Input[str]) - Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

    • threshold (pulumi.Input[float]) - The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.

  • operator (pulumi.Input[str]) - Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

  • threshold (pulumi.Input[float]) - Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.

action: pulumi.Output[dict] = None

An action block as defined below.

  • actionGroups (list) - List of action group reference resource IDs.

  • customWebhookPayload (str) - Custom payload to be sent for all webhook payloads in alerting action.

  • emailSubject (str) - Custom subject override for all email ids in Azure action group.

authorized_resource_ids: pulumi.Output[list] = None

List of Resource IDs referred into query.

data_source_id: pulumi.Output[str] = None

The resource URI over which log search query is to be run.

description: pulumi.Output[str] = None

The description of the scheduled query rule.

enabled: pulumi.Output[bool] = None

Whether this scheduled query rule is enabled. Default is true.

frequency: pulumi.Output[float] = None

Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).

name: pulumi.Output[str] = None

The name of the scheduled query rule. Changing this forces a new resource to be created.

query: pulumi.Output[str] = None

Log search query.

resource_group_name: pulumi.Output[str] = None

The name of the resource group in which to create the scheduled query rule instance.

severity: pulumi.Output[float] = None

Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.

throttling: pulumi.Output[float] = None

Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

time_window: pulumi.Output[float] = None

Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).

trigger: pulumi.Output[dict] = None

The condition that results in the alert rule being run.

  • metricTrigger (dict)

    • metricColumn (str)

    • metricTriggerType (str)

    • operator (str) - Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

    • threshold (float) - The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.

  • operator (str) - Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

  • threshold (float) - Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.

static get(resource_name, id, opts=None, action=None, authorized_resource_ids=None, data_source_id=None, description=None, enabled=None, frequency=None, location=None, name=None, query=None, query_type=None, resource_group_name=None, severity=None, tags=None, throttling=None, time_window=None, trigger=None)

Get an existing ScheduledQueryRulesAlert 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.

  • action (pulumi.Input[dict]) – An action block as defined below.

  • authorized_resource_ids (pulumi.Input[list]) – List of Resource IDs referred into query.

  • data_source_id (pulumi.Input[str]) – The resource URI over which log search query is to be run.

  • description (pulumi.Input[str]) – The description of the scheduled query rule.

  • enabled (pulumi.Input[bool]) – Whether this scheduled query rule is enabled. Default is true.

  • frequency (pulumi.Input[float]) – Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).

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

  • query (pulumi.Input[str]) – Log search query.

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

  • severity (pulumi.Input[float]) – Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.

  • throttling (pulumi.Input[float]) – Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

  • time_window (pulumi.Input[float]) – Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).

  • trigger (pulumi.Input[dict]) – The condition that results in the alert rule being run.

The action object supports the following:

  • actionGroups (pulumi.Input[list]) - List of action group reference resource IDs.

  • customWebhookPayload (pulumi.Input[str]) - Custom payload to be sent for all webhook payloads in alerting action.

  • emailSubject (pulumi.Input[str]) - Custom subject override for all email ids in Azure action group.

The trigger object supports the following:

  • metricTrigger (pulumi.Input[dict])

    • metricColumn (pulumi.Input[str])

    • metricTriggerType (pulumi.Input[str])

    • operator (pulumi.Input[str]) - Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

    • threshold (pulumi.Input[float]) - The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.

  • operator (pulumi.Input[str]) - Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

  • threshold (pulumi.Input[float]) - Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.

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.ScheduledQueryRulesLog(resource_name, opts=None, authorized_resource_ids=None, criteria=None, data_source_id=None, description=None, enabled=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages a LogToMetricAction Scheduled Query Rules resource within Azure Monitor.

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

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

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

  • data_source_id (pulumi.Input[str]) – The resource uri over which log search query is to be run.

  • description (pulumi.Input[str]) – The description of the scheduled query rule.

  • enabled (pulumi.Input[bool]) – Whether this scheduled query rule is enabled. Default is true.

  • name (pulumi.Input[str]) – The name of the scheduled query rule. 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 scheduled query rule instance.

The criteria object supports the following:

  • dimensions (pulumi.Input[list]) - A dimension block as defined below.

    • name (pulumi.Input[str]) - Name of the dimension.

    • operator (pulumi.Input[str]) - Operator for dimension values, - ‘Include’.

    • values (pulumi.Input[list]) - List of dimension values.

  • metricName (pulumi.Input[str]) - Name of the metric. Supported metrics are listed in the Azure Monitor Microsoft.OperationalInsights/workspaces metrics namespace.

criteria: pulumi.Output[dict] = None

A criteria block as defined below.

  • dimensions (list) - A dimension block as defined below.

    • name (str) - Name of the dimension.

    • operator (str) - Operator for dimension values, - ‘Include’.

    • values (list) - List of dimension values.

  • metricName (str) - Name of the metric. Supported metrics are listed in the Azure Monitor Microsoft.OperationalInsights/workspaces metrics namespace.

data_source_id: pulumi.Output[str] = None

The resource uri over which log search query is to be run.

description: pulumi.Output[str] = None

The description of the scheduled query rule.

enabled: pulumi.Output[bool] = None

Whether this scheduled query rule is enabled. Default is true.

name: pulumi.Output[str] = None

The name of the scheduled query rule. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None

The name of the resource group in which to create the scheduled query rule instance.

static get(resource_name, id, opts=None, authorized_resource_ids=None, criteria=None, data_source_id=None, description=None, enabled=None, location=None, name=None, resource_group_name=None, tags=None)

Get an existing ScheduledQueryRulesLog 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.

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

  • data_source_id (pulumi.Input[str]) – The resource uri over which log search query is to be run.

  • description (pulumi.Input[str]) – The description of the scheduled query rule.

  • enabled (pulumi.Input[bool]) – Whether this scheduled query rule is enabled. Default is true.

  • name (pulumi.Input[str]) – The name of the scheduled query rule. 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 scheduled query rule instance.

The criteria object supports the following:

  • dimensions (pulumi.Input[list]) - A dimension block as defined below.

    • name (pulumi.Input[str]) - Name of the dimension.

    • operator (pulumi.Input[str]) - Operator for dimension values, - ‘Include’.

    • values (pulumi.Input[list]) - List of dimension values.

  • metricName (pulumi.Input[str]) - Name of the metric. Supported metrics are listed in the Azure Monitor Microsoft.OperationalInsights/workspaces metrics namespace.

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.

import pulumi
import pulumi_azure as azure

example = azure.monitoring.get_action_group(resource_group_name="example-rg",
    name="tfex-actiongroup")
pulumi.export("actionGroupId", example.id)
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.

import pulumi
import pulumi_azure as azure

example_key_vault = azure.keyvault.get_key_vault(name=azurerm_key_vault["example"]["name"],
    resource_group_name=azurerm_key_vault["example"]["resource_group_name"])
example_diagnostic_categories = azure.monitoring.get_diagnostic_categories(resource_id=example_key_vault.id)
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.

import pulumi
import pulumi_azure as azure

example = azure.monitoring.get_log_profile(name="test-logprofile")
pulumi.export("logProfileStorageAccountId", example.storage_account_id)
Parameters

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

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

Use this data source to access the properties of an AlertingAction scheduled query rule.

import pulumi
import pulumi_azure as azure

example = azure.monitoring.get_scheduled_query_rules_alert(name="tfex-queryrule",
    resource_group_name="example-rg")
pulumi.export("queryRuleId", example.id)
Parameters
  • name (str) – Specifies the name of the scheduled query rule.

  • resource_group_name (str) – Specifies the name of the resource group where the scheduled query rule is located.

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

Use this data source to access the properties of a LogToMetricAction scheduled query rule.

import pulumi
import pulumi_azure as azure

example = azure.monitoring.get_scheduled_query_rules_log(name="tfex-queryrule",
    resource_group_name="example-rg")
pulumi.export("queryRuleId", example.id)
Parameters
  • name (str) – Specifies the name of the scheduled query rule.

  • resource_group_name (str) – Specifies the name of the resource group where the scheduled query rule is located.