ActivityLogAlert

Manages an Activity Log Alert within Azure Monitor.

Create a ActivityLogAlert Resource

def 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 string
The unique name of the resource.
args ActivityLogAlertArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ActivityLogAlertArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ActivityLogAlertArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ActivityLogAlert Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ActivityLogAlert resource accepts the following input properties:

Criteria ActivityLogAlertCriteriaArgs

A criteria block as defined below.

ResourceGroupName string

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

Scopes List<string>

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

Actions List<ActivityLogAlertActionArgs>

One or more action blocks as defined below.

Description string

The description of this activity log alert.

Enabled bool

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

Name string

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

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

Criteria ActivityLogAlertCriteria

A criteria block as defined below.

ResourceGroupName string

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

Scopes []string

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

Actions []ActivityLogAlertAction

One or more action blocks as defined below.

Description string

The description of this activity log alert.

Enabled bool

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

Name string

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

Tags map[string]string

A mapping of tags to assign to the resource.

criteria ActivityLogAlertCriteria

A criteria block as defined below.

resourceGroupName string

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

scopes string[]

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

actions ActivityLogAlertAction[]

One or more action blocks as defined below.

description string

The description of this activity log alert.

enabled boolean

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

name string

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

tags {[key: string]: string}

A mapping of tags to assign to the resource.

criteria Dict[ActivityLogAlertCriteria]

A criteria block as defined below.

resource_group_name str

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

scopes List[str]

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

actions List[ActivityLogAlertAction]

One or more action blocks as defined below.

description str

The description of this activity log alert.

enabled bool

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

name str

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

tags Dict[str, str]

A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ActivityLogAlert resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing ActivityLogAlert Resource

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

public static get(name: string, id: Input<ID>, state?: ActivityLogAlertState, opts?: CustomResourceOptions): ActivityLogAlert
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, __props__=None);
func GetActivityLogAlert(ctx *Context, name string, id IDInput, state *ActivityLogAlertState, opts ...ResourceOption) (*ActivityLogAlert, error)
public static ActivityLogAlert Get(string name, Input<string> id, ActivityLogAlertState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Actions List<ActivityLogAlertActionArgs>

One or more action blocks as defined below.

Criteria ActivityLogAlertCriteriaArgs

A criteria block as defined below.

Description string

The description of this activity log alert.

Enabled bool

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

Name string

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

ResourceGroupName string

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

Scopes List<string>

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 Dictionary<string, string>

A mapping of tags to assign to the resource.

Actions []ActivityLogAlertAction

One or more action blocks as defined below.

Criteria ActivityLogAlertCriteria

A criteria block as defined below.

Description string

The description of this activity log alert.

Enabled bool

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

Name string

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

ResourceGroupName string

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

Scopes []string

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 map[string]string

A mapping of tags to assign to the resource.

actions ActivityLogAlertAction[]

One or more action blocks as defined below.

criteria ActivityLogAlertCriteria

A criteria block as defined below.

description string

The description of this activity log alert.

enabled boolean

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

name string

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

resourceGroupName string

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

scopes string[]

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 {[key: string]: string}

A mapping of tags to assign to the resource.

actions List[ActivityLogAlertAction]

One or more action blocks as defined below.

criteria Dict[ActivityLogAlertCriteria]

A criteria block as defined below.

description str

The description of this activity log alert.

enabled bool

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

name str

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

resource_group_name str

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

scopes List[str]

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 Dict[str, str]

A mapping of tags to assign to the resource.

Supporting Types

ActivityLogAlertAction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ActionGroupId string

The ID of the Action Group can be sourced from the azure.monitoring.ActionGroup resource.

WebhookProperties Dictionary<string, string>

The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

ActionGroupId string

The ID of the Action Group can be sourced from the azure.monitoring.ActionGroup resource.

WebhookProperties map[string]string

The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

actionGroupId string

The ID of the Action Group can be sourced from the azure.monitoring.ActionGroup resource.

webhookProperties {[key: string]: string}

The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

action_group_id str

The ID of the Action Group can be sourced from the azure.monitoring.ActionGroup resource.

webhookProperties Dict[str, str]

The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

ActivityLogAlertCriteria

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Category string

The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

Caller string

The email address or Azure Active Directory identifier of the user who performed the operation.

Level string

The severity level of the event. Possible values are Verbose, Informational, Warning, Error, and Critical.

OperationName string

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

RecommendationCategory string

The recommendation category of the event. Possible values are Cost, Reliability, OperationalExcellence and Performance. It is only allowed when category is Recommendation.

RecommendationImpact string

The recommendation impact of the event. Possible values are High, Medium and Low. It is only allowed when category is Recommendation.

RecommendationType string

The recommendation type of the event. It is only allowed when category is Recommendation.

ResourceGroup string

The name of resource group monitored by the activity log alert.

ResourceId string

The specific resource monitored by the activity log alert. It should be within one of the scopes.

ResourceProvider string

The name of the resource provider monitored by the activity log alert.

ResourceType string

The resource type monitored by the activity log alert.

Status string

The status of the event. For example, Started, Failed, or Succeeded.

SubStatus string

The sub status of the event.

Category string

The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

Caller string

The email address or Azure Active Directory identifier of the user who performed the operation.

Level string

The severity level of the event. Possible values are Verbose, Informational, Warning, Error, and Critical.

OperationName string

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

RecommendationCategory string

The recommendation category of the event. Possible values are Cost, Reliability, OperationalExcellence and Performance. It is only allowed when category is Recommendation.

RecommendationImpact string

The recommendation impact of the event. Possible values are High, Medium and Low. It is only allowed when category is Recommendation.

RecommendationType string

The recommendation type of the event. It is only allowed when category is Recommendation.

ResourceGroup string

The name of resource group monitored by the activity log alert.

ResourceId string

The specific resource monitored by the activity log alert. It should be within one of the scopes.

ResourceProvider string

The name of the resource provider monitored by the activity log alert.

ResourceType string

The resource type monitored by the activity log alert.

Status string

The status of the event. For example, Started, Failed, or Succeeded.

SubStatus string

The sub status of the event.

category string

The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

caller string

The email address or Azure Active Directory identifier of the user who performed the operation.

level string

The severity level of the event. Possible values are Verbose, Informational, Warning, Error, and Critical.

operationName string

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

recommendationCategory string

The recommendation category of the event. Possible values are Cost, Reliability, OperationalExcellence and Performance. It is only allowed when category is Recommendation.

recommendationImpact string

The recommendation impact of the event. Possible values are High, Medium and Low. It is only allowed when category is Recommendation.

recommendationType string

The recommendation type of the event. It is only allowed when category is Recommendation.

resourceGroup string

The name of resource group monitored by the activity log alert.

resourceId string

The specific resource monitored by the activity log alert. It should be within one of the scopes.

resourceProvider string

The name of the resource provider monitored by the activity log alert.

resourceType string

The resource type monitored by the activity log alert.

status string

The status of the event. For example, Started, Failed, or Succeeded.

subStatus string

The sub status of the event.

category str

The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

caller str

The email address or Azure Active Directory identifier of the user who performed the operation.

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

recommendationCategory str

The recommendation category of the event. Possible values are Cost, Reliability, OperationalExcellence and Performance. It is only allowed when category is Recommendation.

recommendationImpact str

The recommendation impact of the event. Possible values are High, Medium and Low. It is only allowed when category is Recommendation.

recommendationType str

The recommendation type of the event. It is only allowed when category is Recommendation.

resourceGroup str

The name of resource group monitored by the activity log alert.

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.

resource_id str

The specific resource monitored by the activity log alert. It should be within one of the scopes.

status str

The status of the event. For example, Started, Failed, or Succeeded.

subStatus str

The sub status of the event.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.