1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. getAutomationRule
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.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.securityinsights.getAutomationRule

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.29.0 published on Friday, Feb 16, 2024 by Pulumi

    Gets the automation rule. Azure REST API version: 2023-02-01.

    Other available API versions: 2019-01-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview.

    Using getAutomationRule

    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 getAutomationRule(args: GetAutomationRuleArgs, opts?: InvokeOptions): Promise<GetAutomationRuleResult>
    function getAutomationRuleOutput(args: GetAutomationRuleOutputArgs, opts?: InvokeOptions): Output<GetAutomationRuleResult>
    def get_automation_rule(automation_rule_id: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            workspace_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAutomationRuleResult
    def get_automation_rule_output(automation_rule_id: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            workspace_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAutomationRuleResult]
    func LookupAutomationRule(ctx *Context, args *LookupAutomationRuleArgs, opts ...InvokeOption) (*LookupAutomationRuleResult, error)
    func LookupAutomationRuleOutput(ctx *Context, args *LookupAutomationRuleOutputArgs, opts ...InvokeOption) LookupAutomationRuleResultOutput

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

    public static class GetAutomationRule 
    {
        public static Task<GetAutomationRuleResult> InvokeAsync(GetAutomationRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetAutomationRuleResult> Invoke(GetAutomationRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAutomationRuleResult> getAutomationRule(GetAutomationRuleArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:securityinsights:getAutomationRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AutomationRuleId string
    Automation rule ID
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    AutomationRuleId string
    Automation rule ID
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    automationRuleId String
    Automation rule ID
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    automationRuleId string
    Automation rule ID
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The name of the workspace.
    automation_rule_id str
    Automation rule ID
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The name of the workspace.
    automationRuleId String
    Automation rule ID
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.

    getAutomationRule Result

    The following output properties are available:

    Actions List<Union<Pulumi.AzureNative.SecurityInsights.Outputs.AutomationRuleModifyPropertiesActionResponse, Pulumi.AzureNative.SecurityInsights.Outputs.AutomationRuleRunPlaybookActionResponse>>
    The actions to execute when the automation rule is triggered.
    CreatedBy Pulumi.AzureNative.SecurityInsights.Outputs.ClientInfoResponse
    Information on the client (user or application) that made some action
    CreatedTimeUtc string
    The time the automation rule was created.
    DisplayName string
    The display name of the automation rule.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastModifiedBy Pulumi.AzureNative.SecurityInsights.Outputs.ClientInfoResponse
    Information on the client (user or application) that made some action
    LastModifiedTimeUtc string
    The last time the automation rule was updated.
    Name string
    The name of the resource
    Order int
    The order of execution of the automation rule.
    SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TriggeringLogic Pulumi.AzureNative.SecurityInsights.Outputs.AutomationRuleTriggeringLogicResponse
    Describes automation rule triggering logic.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    Etag of the azure resource
    Actions []interface{}
    The actions to execute when the automation rule is triggered.
    CreatedBy ClientInfoResponse
    Information on the client (user or application) that made some action
    CreatedTimeUtc string
    The time the automation rule was created.
    DisplayName string
    The display name of the automation rule.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastModifiedBy ClientInfoResponse
    Information on the client (user or application) that made some action
    LastModifiedTimeUtc string
    The last time the automation rule was updated.
    Name string
    The name of the resource
    Order int
    The order of execution of the automation rule.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TriggeringLogic AutomationRuleTriggeringLogicResponse
    Describes automation rule triggering logic.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    Etag of the azure resource
    actions List<Either<AutomationRuleModifyPropertiesActionResponse,AutomationRuleRunPlaybookActionResponse>>
    The actions to execute when the automation rule is triggered.
    createdBy ClientInfoResponse
    Information on the client (user or application) that made some action
    createdTimeUtc String
    The time the automation rule was created.
    displayName String
    The display name of the automation rule.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedBy ClientInfoResponse
    Information on the client (user or application) that made some action
    lastModifiedTimeUtc String
    The last time the automation rule was updated.
    name String
    The name of the resource
    order Integer
    The order of execution of the automation rule.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    triggeringLogic AutomationRuleTriggeringLogicResponse
    Describes automation rule triggering logic.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Etag of the azure resource
    actions (AutomationRuleModifyPropertiesActionResponse | AutomationRuleRunPlaybookActionResponse)[]
    The actions to execute when the automation rule is triggered.
    createdBy ClientInfoResponse
    Information on the client (user or application) that made some action
    createdTimeUtc string
    The time the automation rule was created.
    displayName string
    The display name of the automation rule.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedBy ClientInfoResponse
    Information on the client (user or application) that made some action
    lastModifiedTimeUtc string
    The last time the automation rule was updated.
    name string
    The name of the resource
    order number
    The order of execution of the automation rule.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    triggeringLogic AutomationRuleTriggeringLogicResponse
    Describes automation rule triggering logic.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag string
    Etag of the azure resource
    actions Sequence[Any]
    The actions to execute when the automation rule is triggered.
    created_by ClientInfoResponse
    Information on the client (user or application) that made some action
    created_time_utc str
    The time the automation rule was created.
    display_name str
    The display name of the automation rule.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    last_modified_by ClientInfoResponse
    Information on the client (user or application) that made some action
    last_modified_time_utc str
    The last time the automation rule was updated.
    name str
    The name of the resource
    order int
    The order of execution of the automation rule.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    triggering_logic AutomationRuleTriggeringLogicResponse
    Describes automation rule triggering logic.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag str
    Etag of the azure resource
    actions List<Property Map | Property Map>
    The actions to execute when the automation rule is triggered.
    createdBy Property Map
    Information on the client (user or application) that made some action
    createdTimeUtc String
    The time the automation rule was created.
    displayName String
    The display name of the automation rule.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedBy Property Map
    Information on the client (user or application) that made some action
    lastModifiedTimeUtc String
    The last time the automation rule was updated.
    name String
    The name of the resource
    order Number
    The order of execution of the automation rule.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    triggeringLogic Property Map
    Describes automation rule triggering logic.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Etag of the azure resource

    Supporting Types

    AutomationRuleModifyPropertiesActionResponse

    AutomationRulePropertyArrayChangedValuesConditionResponse

    ArrayType string
    ChangeType string
    ArrayType string
    ChangeType string
    arrayType String
    changeType String
    arrayType string
    changeType string
    arrayType String
    changeType String

    AutomationRulePropertyValuesChangedConditionResponse

    ChangeType string
    Operator string
    PropertyName string
    PropertyValues List<string>
    ChangeType string
    Operator string
    PropertyName string
    PropertyValues []string
    changeType String
    operator String
    propertyName String
    propertyValues List<String>
    changeType string
    operator string
    propertyName string
    propertyValues string[]
    changeType String
    operator String
    propertyName String
    propertyValues List<String>

    AutomationRulePropertyValuesConditionResponse

    Operator string
    PropertyName string
    The property to evaluate in an automation rule property condition.
    PropertyValues List<string>
    Operator string
    PropertyName string
    The property to evaluate in an automation rule property condition.
    PropertyValues []string
    operator String
    propertyName String
    The property to evaluate in an automation rule property condition.
    propertyValues List<String>
    operator string
    propertyName string
    The property to evaluate in an automation rule property condition.
    propertyValues string[]
    operator str
    property_name str
    The property to evaluate in an automation rule property condition.
    property_values Sequence[str]
    operator String
    propertyName String
    The property to evaluate in an automation rule property condition.
    propertyValues List<String>

    AutomationRuleRunPlaybookActionResponse

    AutomationRuleTriggeringLogicResponse

    IsEnabled bool
    Determines whether the automation rule is enabled or disabled.
    TriggersOn string
    TriggersWhen string
    Conditions List<object>
    The conditions to evaluate to determine if the automation rule should be triggered on a given object.
    ExpirationTimeUtc string
    Determines when the automation rule should automatically expire and be disabled.
    IsEnabled bool
    Determines whether the automation rule is enabled or disabled.
    TriggersOn string
    TriggersWhen string
    Conditions []interface{}
    The conditions to evaluate to determine if the automation rule should be triggered on a given object.
    ExpirationTimeUtc string
    Determines when the automation rule should automatically expire and be disabled.
    isEnabled Boolean
    Determines whether the automation rule is enabled or disabled.
    triggersOn String
    triggersWhen String
    conditions List<Object>
    The conditions to evaluate to determine if the automation rule should be triggered on a given object.
    expirationTimeUtc String
    Determines when the automation rule should automatically expire and be disabled.
    isEnabled boolean
    Determines whether the automation rule is enabled or disabled.
    triggersOn string
    triggersWhen string
    conditions (PropertyArrayChangedConditionPropertiesResponse | PropertyChangedConditionPropertiesResponse | PropertyConditionPropertiesResponse)[]
    The conditions to evaluate to determine if the automation rule should be triggered on a given object.
    expirationTimeUtc string
    Determines when the automation rule should automatically expire and be disabled.
    is_enabled bool
    Determines whether the automation rule is enabled or disabled.
    triggers_on str
    triggers_when str
    conditions Sequence[Union[PropertyArrayChangedConditionPropertiesResponse, PropertyChangedConditionPropertiesResponse, PropertyConditionPropertiesResponse]]
    The conditions to evaluate to determine if the automation rule should be triggered on a given object.
    expiration_time_utc str
    Determines when the automation rule should automatically expire and be disabled.
    isEnabled Boolean
    Determines whether the automation rule is enabled or disabled.
    triggersOn String
    triggersWhen String
    conditions List<Property Map | Property Map | Property Map>
    The conditions to evaluate to determine if the automation rule should be triggered on a given object.
    expirationTimeUtc String
    Determines when the automation rule should automatically expire and be disabled.

    ClientInfoResponse

    Email string
    The email of the client.
    Name string
    The name of the client.
    ObjectId string
    The object id of the client.
    UserPrincipalName string
    The user principal name of the client.
    Email string
    The email of the client.
    Name string
    The name of the client.
    ObjectId string
    The object id of the client.
    UserPrincipalName string
    The user principal name of the client.
    email String
    The email of the client.
    name String
    The name of the client.
    objectId String
    The object id of the client.
    userPrincipalName String
    The user principal name of the client.
    email string
    The email of the client.
    name string
    The name of the client.
    objectId string
    The object id of the client.
    userPrincipalName string
    The user principal name of the client.
    email str
    The email of the client.
    name str
    The name of the client.
    object_id str
    The object id of the client.
    user_principal_name str
    The user principal name of the client.
    email String
    The email of the client.
    name String
    The name of the client.
    objectId String
    The object id of the client.
    userPrincipalName String
    The user principal name of the client.

    IncidentLabelResponse

    LabelName string
    The name of the label
    LabelType string
    The type of the label
    LabelName string
    The name of the label
    LabelType string
    The type of the label
    labelName String
    The name of the label
    labelType String
    The type of the label
    labelName string
    The name of the label
    labelType string
    The type of the label
    label_name str
    The name of the label
    label_type str
    The type of the label
    labelName String
    The name of the label
    labelType String
    The type of the label

    IncidentOwnerInfoResponse

    AssignedTo string
    The name of the user the incident is assigned to.
    Email string
    The email of the user the incident is assigned to.
    ObjectId string
    The object id of the user the incident is assigned to.
    OwnerType string
    The type of the owner the incident is assigned to.
    UserPrincipalName string
    The user principal name of the user the incident is assigned to.
    AssignedTo string
    The name of the user the incident is assigned to.
    Email string
    The email of the user the incident is assigned to.
    ObjectId string
    The object id of the user the incident is assigned to.
    OwnerType string
    The type of the owner the incident is assigned to.
    UserPrincipalName string
    The user principal name of the user the incident is assigned to.
    assignedTo String
    The name of the user the incident is assigned to.
    email String
    The email of the user the incident is assigned to.
    objectId String
    The object id of the user the incident is assigned to.
    ownerType String
    The type of the owner the incident is assigned to.
    userPrincipalName String
    The user principal name of the user the incident is assigned to.
    assignedTo string
    The name of the user the incident is assigned to.
    email string
    The email of the user the incident is assigned to.
    objectId string
    The object id of the user the incident is assigned to.
    ownerType string
    The type of the owner the incident is assigned to.
    userPrincipalName string
    The user principal name of the user the incident is assigned to.
    assigned_to str
    The name of the user the incident is assigned to.
    email str
    The email of the user the incident is assigned to.
    object_id str
    The object id of the user the incident is assigned to.
    owner_type str
    The type of the owner the incident is assigned to.
    user_principal_name str
    The user principal name of the user the incident is assigned to.
    assignedTo String
    The name of the user the incident is assigned to.
    email String
    The email of the user the incident is assigned to.
    objectId String
    The object id of the user the incident is assigned to.
    ownerType String
    The type of the owner the incident is assigned to.
    userPrincipalName String
    The user principal name of the user the incident is assigned to.

    IncidentPropertiesActionResponse

    Classification string
    The reason the incident was closed
    ClassificationComment string
    Describes the reason the incident was closed.
    ClassificationReason string
    The classification reason the incident was closed with
    Labels List<Pulumi.AzureNative.SecurityInsights.Inputs.IncidentLabelResponse>
    List of labels to add to the incident.
    Owner Pulumi.AzureNative.SecurityInsights.Inputs.IncidentOwnerInfoResponse
    Information on the user an incident is assigned to
    Severity string
    The severity of the incident
    Status string
    The status of the incident
    Classification string
    The reason the incident was closed
    ClassificationComment string
    Describes the reason the incident was closed.
    ClassificationReason string
    The classification reason the incident was closed with
    Labels []IncidentLabelResponse
    List of labels to add to the incident.
    Owner IncidentOwnerInfoResponse
    Information on the user an incident is assigned to
    Severity string
    The severity of the incident
    Status string
    The status of the incident
    classification String
    The reason the incident was closed
    classificationComment String
    Describes the reason the incident was closed.
    classificationReason String
    The classification reason the incident was closed with
    labels List<IncidentLabelResponse>
    List of labels to add to the incident.
    owner IncidentOwnerInfoResponse
    Information on the user an incident is assigned to
    severity String
    The severity of the incident
    status String
    The status of the incident
    classification string
    The reason the incident was closed
    classificationComment string
    Describes the reason the incident was closed.
    classificationReason string
    The classification reason the incident was closed with
    labels IncidentLabelResponse[]
    List of labels to add to the incident.
    owner IncidentOwnerInfoResponse
    Information on the user an incident is assigned to
    severity string
    The severity of the incident
    status string
    The status of the incident
    classification str
    The reason the incident was closed
    classification_comment str
    Describes the reason the incident was closed.
    classification_reason str
    The classification reason the incident was closed with
    labels Sequence[IncidentLabelResponse]
    List of labels to add to the incident.
    owner IncidentOwnerInfoResponse
    Information on the user an incident is assigned to
    severity str
    The severity of the incident
    status str
    The status of the incident
    classification String
    The reason the incident was closed
    classificationComment String
    Describes the reason the incident was closed.
    classificationReason String
    The classification reason the incident was closed with
    labels List<Property Map>
    List of labels to add to the incident.
    owner Property Map
    Information on the user an incident is assigned to
    severity String
    The severity of the incident
    status String
    The status of the incident

    PlaybookActionPropertiesResponse

    LogicAppResourceId string
    The resource id of the playbook resource.
    TenantId string
    The tenant id of the playbook resource.
    LogicAppResourceId string
    The resource id of the playbook resource.
    TenantId string
    The tenant id of the playbook resource.
    logicAppResourceId String
    The resource id of the playbook resource.
    tenantId String
    The tenant id of the playbook resource.
    logicAppResourceId string
    The resource id of the playbook resource.
    tenantId string
    The tenant id of the playbook resource.
    logic_app_resource_id str
    The resource id of the playbook resource.
    tenant_id str
    The tenant id of the playbook resource.
    logicAppResourceId String
    The resource id of the playbook resource.
    tenantId String
    The tenant id of the playbook resource.

    PropertyArrayChangedConditionPropertiesResponse

    PropertyChangedConditionPropertiesResponse

    PropertyConditionPropertiesResponse

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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.29.0 published on Friday, Feb 16, 2024 by Pulumi