1. Packages
  2. Azure Native
  3. API Docs
  4. insights
  5. getActivityLogAlert
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

azure-native.insights.getActivityLogAlert

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.10.0 published on Wednesday, Oct 4, 2023 by Pulumi

    Get an Activity Log Alert rule. Azure REST API version: 2023-01-01-preview.

    Using getActivityLogAlert

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getActivityLogAlert(args: GetActivityLogAlertArgs, opts?: InvokeOptions): Promise<GetActivityLogAlertResult>
    function getActivityLogAlertOutput(args: GetActivityLogAlertOutputArgs, opts?: InvokeOptions): Output<GetActivityLogAlertResult>
    def get_activity_log_alert(activity_log_alert_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetActivityLogAlertResult
    def get_activity_log_alert_output(activity_log_alert_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetActivityLogAlertResult]
    func LookupActivityLogAlert(ctx *Context, args *LookupActivityLogAlertArgs, opts ...InvokeOption) (*LookupActivityLogAlertResult, error)
    func LookupActivityLogAlertOutput(ctx *Context, args *LookupActivityLogAlertOutputArgs, opts ...InvokeOption) LookupActivityLogAlertResultOutput

    > Note: This function is named LookupActivityLogAlert in the Go SDK.

    public static class GetActivityLogAlert 
    {
        public static Task<GetActivityLogAlertResult> InvokeAsync(GetActivityLogAlertArgs args, InvokeOptions? opts = null)
        public static Output<GetActivityLogAlertResult> Invoke(GetActivityLogAlertInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetActivityLogAlertResult> getActivityLogAlert(GetActivityLogAlertArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:insights:getActivityLogAlert
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ActivityLogAlertName string

    The name of the Activity Log Alert rule.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    ActivityLogAlertName string

    The name of the Activity Log Alert rule.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    activityLogAlertName String

    The name of the Activity Log Alert rule.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    activityLogAlertName string

    The name of the Activity Log Alert rule.

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    activity_log_alert_name str

    The name of the Activity Log Alert rule.

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    activityLogAlertName String

    The name of the Activity Log Alert rule.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    getActivityLogAlert Result

    The following output properties are available:

    Actions Pulumi.AzureNative.Insights.Outputs.ActionListResponse

    The actions that will activate when the condition is met.

    Condition Pulumi.AzureNative.Insights.Outputs.AlertRuleAllOfConditionResponse

    The condition that will cause this alert to activate.

    Id string

    The resource Id.

    Name string

    The name of the resource.

    Type string

    The type of the resource.

    Description string

    A description of this Activity Log Alert rule.

    Enabled bool

    Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.

    Location string

    The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'.

    Scopes List<string>

    A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.

    Tags Dictionary<string, string>

    The tags of the resource.

    TenantScope string

    The tenant GUID. Must be provided for tenant-level and management group events rules.

    Actions ActionListResponse

    The actions that will activate when the condition is met.

    Condition AlertRuleAllOfConditionResponse

    The condition that will cause this alert to activate.

    Id string

    The resource Id.

    Name string

    The name of the resource.

    Type string

    The type of the resource.

    Description string

    A description of this Activity Log Alert rule.

    Enabled bool

    Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.

    Location string

    The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'.

    Scopes []string

    A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.

    Tags map[string]string

    The tags of the resource.

    TenantScope string

    The tenant GUID. Must be provided for tenant-level and management group events rules.

    actions ActionListResponse

    The actions that will activate when the condition is met.

    condition AlertRuleAllOfConditionResponse

    The condition that will cause this alert to activate.

    id String

    The resource Id.

    name String

    The name of the resource.

    type String

    The type of the resource.

    description String

    A description of this Activity Log Alert rule.

    enabled Boolean

    Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.

    location String

    The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'.

    scopes List<String>

    A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.

    tags Map<String,String>

    The tags of the resource.

    tenantScope String

    The tenant GUID. Must be provided for tenant-level and management group events rules.

    actions ActionListResponse

    The actions that will activate when the condition is met.

    condition AlertRuleAllOfConditionResponse

    The condition that will cause this alert to activate.

    id string

    The resource Id.

    name string

    The name of the resource.

    type string

    The type of the resource.

    description string

    A description of this Activity Log Alert rule.

    enabled boolean

    Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.

    location string

    The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'.

    scopes string[]

    A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.

    tags {[key: string]: string}

    The tags of the resource.

    tenantScope string

    The tenant GUID. Must be provided for tenant-level and management group events rules.

    actions ActionListResponse

    The actions that will activate when the condition is met.

    condition AlertRuleAllOfConditionResponse

    The condition that will cause this alert to activate.

    id str

    The resource Id.

    name str

    The name of the resource.

    type str

    The type of the resource.

    description str

    A description of this Activity Log Alert rule.

    enabled bool

    Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.

    location str

    The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'.

    scopes Sequence[str]

    A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.

    tags Mapping[str, str]

    The tags of the resource.

    tenant_scope str

    The tenant GUID. Must be provided for tenant-level and management group events rules.

    actions Property Map

    The actions that will activate when the condition is met.

    condition Property Map

    The condition that will cause this alert to activate.

    id String

    The resource Id.

    name String

    The name of the resource.

    type String

    The type of the resource.

    description String

    A description of this Activity Log Alert rule.

    enabled Boolean

    Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated.

    location String

    The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'.

    scopes List<String>

    A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item.

    tags Map<String>

    The tags of the resource.

    tenantScope String

    The tenant GUID. Must be provided for tenant-level and management group events rules.

    Supporting Types

    ActionGroupResponse

    ActionGroupId string

    The resource ID of the Action Group. This cannot be null or empty.

    ActionProperties Dictionary<string, string>

    Predefined list of properties and configuration items for the action group.

    WebhookProperties Dictionary<string, string>

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

    ActionGroupId string

    The resource ID of the Action Group. This cannot be null or empty.

    ActionProperties map[string]string

    Predefined list of properties and configuration items for the action group.

    WebhookProperties map[string]string

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

    actionGroupId String

    The resource ID of the Action Group. This cannot be null or empty.

    actionProperties Map<String,String>

    Predefined list of properties and configuration items for the action group.

    webhookProperties Map<String,String>

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

    actionGroupId string

    The resource ID of the Action Group. This cannot be null or empty.

    actionProperties {[key: string]: string}

    Predefined list of properties and configuration items for the action group.

    webhookProperties {[key: string]: string}

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

    action_group_id str

    The resource ID of the Action Group. This cannot be null or empty.

    action_properties Mapping[str, str]

    Predefined list of properties and configuration items for the action group.

    webhook_properties Mapping[str, str]

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

    actionGroupId String

    The resource ID of the Action Group. This cannot be null or empty.

    actionProperties Map<String>

    Predefined list of properties and configuration items for the action group.

    webhookProperties Map<String>

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

    ActionListResponse

    ActionGroups []ActionGroupResponse

    The list of the Action Groups.

    actionGroups List<ActionGroupResponse>

    The list of the Action Groups.

    actionGroups ActionGroupResponse[]

    The list of the Action Groups.

    action_groups Sequence[ActionGroupResponse]

    The list of the Action Groups.

    actionGroups List<Property Map>

    The list of the Action Groups.

    AlertRuleAllOfConditionResponse

    AllOf []AlertRuleAnyOfOrLeafConditionResponse

    The list of Activity Log Alert rule conditions.

    allOf List<AlertRuleAnyOfOrLeafConditionResponse>

    The list of Activity Log Alert rule conditions.

    allOf AlertRuleAnyOfOrLeafConditionResponse[]

    The list of Activity Log Alert rule conditions.

    all_of Sequence[AlertRuleAnyOfOrLeafConditionResponse]

    The list of Activity Log Alert rule conditions.

    allOf List<Property Map>

    The list of Activity Log Alert rule conditions.

    AlertRuleAnyOfOrLeafConditionResponse

    AnyOf List<Pulumi.AzureNative.Insights.Inputs.AlertRuleLeafConditionResponse>

    An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met.

    ContainsAny List<string>

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    Equals string

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    Field string

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    AnyOf []AlertRuleLeafConditionResponse

    An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met.

    ContainsAny []string

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    Equals string

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    Field string

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    anyOf List<AlertRuleLeafConditionResponse>

    An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met.

    containsAny List<String>

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals_ String

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field String

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    anyOf AlertRuleLeafConditionResponse[]

    An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met.

    containsAny string[]

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals string

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field string

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    any_of Sequence[AlertRuleLeafConditionResponse]

    An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met.

    contains_any Sequence[str]

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals str

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field str

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    anyOf List<Property Map>

    An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met.

    containsAny List<String>

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals String

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field String

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    AlertRuleLeafConditionResponse

    ContainsAny List<string>

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    Equals string

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    Field string

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    ContainsAny []string

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    Equals string

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    Field string

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    containsAny List<String>

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals_ String

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field String

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    containsAny string[]

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals string

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field string

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    contains_any Sequence[str]

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals str

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field str

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    containsAny List<String>

    The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met.

    equals String

    The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met.

    field String

    The name of the Activity Log event's field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.10.0 published on Wednesday, Oct 4, 2023 by Pulumi