Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getAutomationRule

Represents an automation rule. API Version: 2019-01-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,
                        operational_insights_resource_provider: 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,
                        operational_insights_resource_provider: 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

OperationalInsightsResourceProvider string

The namespace of workspaces resource provider- Microsoft.OperationalInsights.

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

WorkspaceName string

The name of the workspace.

AutomationRuleId string

Automation rule ID

OperationalInsightsResourceProvider string

The namespace of workspaces resource provider- Microsoft.OperationalInsights.

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

WorkspaceName string

The name of the workspace.

automationRuleId String

Automation rule ID

operationalInsightsResourceProvider String

The namespace of workspaces resource provider- Microsoft.OperationalInsights.

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

workspaceName String

The name of the workspace.

automationRuleId string

Automation rule ID

operationalInsightsResourceProvider string

The namespace of workspaces resource provider- Microsoft.OperationalInsights.

resourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

workspaceName string

The name of the workspace.

automation_rule_id str

Automation rule ID

operational_insights_resource_provider str

The namespace of workspaces resource provider- Microsoft.OperationalInsights.

resource_group_name str

The name of the resource group within the user's subscription. The name is case insensitive.

workspace_name str

The name of the workspace.

automationRuleId String

Automation rule ID

operationalInsightsResourceProvider String

The namespace of workspaces resource provider- Microsoft.OperationalInsights.

resourceGroupName String

The name of the resource group within the user's subscription. 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

Describes the client that created the automation rule

CreatedTimeUtc string

The time the automation rule was created

DisplayName string

The display name of the automation rule

Id string

Azure resource Id

LastModifiedBy Pulumi.AzureNative.SecurityInsights.Outputs.ClientInfoResponse

Describes the client that last updated the automation rule

LastModifiedTimeUtc string

The last time the automation rule was updated

Name string

Azure resource name

Order int

The order of execution of the automation rule

TriggeringLogic Pulumi.AzureNative.SecurityInsights.Outputs.AutomationRuleTriggeringLogicResponse

The triggering logic of the automation rule

Type string

Azure resource type

Etag string

Etag of the azure resource

Actions []interface{}

The actions to execute when the automation rule is triggered

CreatedBy ClientInfoResponse

Describes the client that created the automation rule

CreatedTimeUtc string

The time the automation rule was created

DisplayName string

The display name of the automation rule

Id string

Azure resource Id

LastModifiedBy ClientInfoResponse

Describes the client that last updated the automation rule

LastModifiedTimeUtc string

The last time the automation rule was updated

Name string

Azure resource name

Order int

The order of execution of the automation rule

TriggeringLogic AutomationRuleTriggeringLogicResponse

The triggering logic of the automation rule

Type string

Azure resource type

Etag string

Etag of the azure resource

actions List<Either<AutomationRuleModifyPropertiesActionResponse,AutomationRuleRunPlaybookActionResponse>>

The actions to execute when the automation rule is triggered

createdBy ClientInfoResponse

Describes the client that created the automation rule

createdTimeUtc String

The time the automation rule was created

displayName String

The display name of the automation rule

id String

Azure resource Id

lastModifiedBy ClientInfoResponse

Describes the client that last updated the automation rule

lastModifiedTimeUtc String

The last time the automation rule was updated

name String

Azure resource name

order Integer

The order of execution of the automation rule

triggeringLogic AutomationRuleTriggeringLogicResponse

The triggering logic of the automation rule

type String

Azure resource type

etag String

Etag of the azure resource

actions (AutomationRuleModifyPropertiesActionResponse | AutomationRuleRunPlaybookActionResponse)[]

The actions to execute when the automation rule is triggered

createdBy ClientInfoResponse

Describes the client that created the automation rule

createdTimeUtc string

The time the automation rule was created

displayName string

The display name of the automation rule

id string

Azure resource Id

lastModifiedBy ClientInfoResponse

Describes the client that last updated the automation rule

lastModifiedTimeUtc string

The last time the automation rule was updated

name string

Azure resource name

order number

The order of execution of the automation rule

triggeringLogic AutomationRuleTriggeringLogicResponse

The triggering logic of the automation rule

type string

Azure resource type

etag string

Etag of the azure resource

actions Sequence[Any]

The actions to execute when the automation rule is triggered

created_by ClientInfoResponse

Describes the client that created the automation rule

created_time_utc str

The time the automation rule was created

display_name str

The display name of the automation rule

id str

Azure resource Id

last_modified_by ClientInfoResponse

Describes the client that last updated the automation rule

last_modified_time_utc str

The last time the automation rule was updated

name str

Azure resource name

order int

The order of execution of the automation rule

triggering_logic AutomationRuleTriggeringLogicResponse

The triggering logic of the automation rule

type str

Azure resource type

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

Describes the client that created the automation rule

createdTimeUtc String

The time the automation rule was created

displayName String

The display name of the automation rule

id String

Azure resource Id

lastModifiedBy Property Map

Describes the client that last updated the automation rule

lastModifiedTimeUtc String

The last time the automation rule was updated

name String

Azure resource name

order Number

The order of execution of the automation rule

triggeringLogic Property Map

The triggering logic of the automation rule

type String

Azure resource type

etag String

Etag of the azure resource

Supporting Types

AutomationRuleModifyPropertiesActionResponse

ActionConfiguration Pulumi.AzureNative.SecurityInsights.Inputs.AutomationRuleModifyPropertiesActionResponseActionConfiguration

The configuration of the modify properties automation rule action

Order int

The order of execution of the automation rule action

ActionConfiguration AutomationRuleModifyPropertiesActionResponseActionConfiguration

The configuration of the modify properties automation rule action

Order int

The order of execution of the automation rule action

actionConfiguration AutomationRuleModifyPropertiesActionResponseActionConfiguration

The configuration of the modify properties automation rule action

order Integer

The order of execution of the automation rule action

actionConfiguration AutomationRuleModifyPropertiesActionResponseActionConfiguration

The configuration of the modify properties automation rule action

order number

The order of execution of the automation rule action

action_configuration AutomationRuleModifyPropertiesActionResponseActionConfiguration

The configuration of the modify properties automation rule action

order int

The order of execution of the automation rule action

actionConfiguration Property Map

The configuration of the modify properties automation rule action

order Number

The order of execution of the automation rule action

AutomationRuleModifyPropertiesActionResponseActionConfiguration

Classification string

The reason the incident was closed

ClassificationComment string

Describes the reason the incident was closed

ClassificationReason string

The classification reason to close the incident with

Labels List<Pulumi.AzureNative.SecurityInsights.Inputs.IncidentLabelResponse>

List of labels to add to the incident

Owner Pulumi.AzureNative.SecurityInsights.Inputs.IncidentOwnerInfoResponse

Describes a user that the 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 to close the incident with

Labels []IncidentLabelResponse

List of labels to add to the incident

Owner IncidentOwnerInfoResponse

Describes a user that the 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 to close the incident with

labels List<IncidentLabelResponse>

List of labels to add to the incident

owner IncidentOwnerInfoResponse

Describes a user that the 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 to close the incident with

labels IncidentLabelResponse[]

List of labels to add to the incident

owner IncidentOwnerInfoResponse

Describes a user that the 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 to close the incident with

labels Sequence[IncidentLabelResponse]

List of labels to add to the incident

owner IncidentOwnerInfoResponse

Describes a user that the 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 to close the incident with

labels List<Property Map>

List of labels to add to the incident

owner Property Map

Describes a user that the incident is assigned to

severity String

The severity of the incident

status String

The status of the incident

AutomationRulePropertyValuesConditionResponse

conditionProperties Property Map

The configuration of the automation rule condition

AutomationRulePropertyValuesConditionResponseConditionProperties

Operator string

The operator to use for evaluation the condition

PropertyName string

The property to evaluate

PropertyValues List<string>

The values to use for evaluating the condition

Operator string

The operator to use for evaluation the condition

PropertyName string

The property to evaluate

PropertyValues []string

The values to use for evaluating the condition

operator String

The operator to use for evaluation the condition

propertyName String

The property to evaluate

propertyValues List<String>

The values to use for evaluating the condition

operator string

The operator to use for evaluation the condition

propertyName string

The property to evaluate

propertyValues string[]

The values to use for evaluating the condition

operator str

The operator to use for evaluation the condition

property_name str

The property to evaluate

property_values Sequence[str]

The values to use for evaluating the condition

operator String

The operator to use for evaluation the condition

propertyName String

The property to evaluate

propertyValues List<String>

The values to use for evaluating the condition

AutomationRuleRunPlaybookActionResponse

ActionConfiguration Pulumi.AzureNative.SecurityInsights.Inputs.AutomationRuleRunPlaybookActionResponseActionConfiguration

The configuration of the run playbook automation rule action

Order int

The order of execution of the automation rule action

ActionConfiguration AutomationRuleRunPlaybookActionResponseActionConfiguration

The configuration of the run playbook automation rule action

Order int

The order of execution of the automation rule action

actionConfiguration AutomationRuleRunPlaybookActionResponseActionConfiguration

The configuration of the run playbook automation rule action

order Integer

The order of execution of the automation rule action

actionConfiguration AutomationRuleRunPlaybookActionResponseActionConfiguration

The configuration of the run playbook automation rule action

order number

The order of execution of the automation rule action

action_configuration AutomationRuleRunPlaybookActionResponseActionConfiguration

The configuration of the run playbook automation rule action

order int

The order of execution of the automation rule action

actionConfiguration Property Map

The configuration of the run playbook automation rule action

order Number

The order of execution of the automation rule action

AutomationRuleRunPlaybookActionResponseActionConfiguration

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

AutomationRuleTriggeringLogicResponse

IsEnabled bool

Determines whether the automation rule is enabled or disabled.

TriggersOn string

The type of object the automation rule triggers on

TriggersWhen string

The type of event the automation rule triggers on

Conditions List<Pulumi.AzureNative.SecurityInsights.Inputs.AutomationRulePropertyValuesConditionResponse>

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

The type of object the automation rule triggers on

TriggersWhen string

The type of event the automation rule triggers on

Conditions []AutomationRulePropertyValuesConditionResponse

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

The type of object the automation rule triggers on

triggersWhen String

The type of event the automation rule triggers on

conditions List<AutomationRulePropertyValuesConditionResponse>

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

The type of object the automation rule triggers on

triggersWhen string

The type of event the automation rule triggers on

conditions AutomationRulePropertyValuesConditionResponse[]

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

The type of object the automation rule triggers on

triggers_when str

The type of event the automation rule triggers on

conditions Sequence[AutomationRulePropertyValuesConditionResponse]

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

The type of object the automation rule triggers on

triggersWhen String

The type of event the automation rule triggers on

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

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.

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.

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.

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.

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.

userPrincipalName String

The user principal name of the user the incident is assigned to.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0