Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.securityinsights.getAutomationRule
Explore with Pulumi AI
Gets the 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:
- Automation
Rule stringId Automation rule ID
- Operational
Insights stringResource Provider The namespace of workspaces resource provider- Microsoft.OperationalInsights.
- Resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- Workspace
Name string The name of the workspace.
- Automation
Rule stringId Automation rule ID
- Operational
Insights stringResource Provider The namespace of workspaces resource provider- Microsoft.OperationalInsights.
- Resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- Workspace
Name string The name of the workspace.
- automation
Rule StringId Automation rule ID
- operational
Insights StringResource Provider The namespace of workspaces resource provider- Microsoft.OperationalInsights.
- resource
Group StringName The name of the resource group within the user's subscription. The name is case insensitive.
- workspace
Name String The name of the workspace.
- automation
Rule stringId Automation rule ID
- operational
Insights stringResource Provider The namespace of workspaces resource provider- Microsoft.OperationalInsights.
- resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- workspace
Name string The name of the workspace.
- automation_
rule_ strid Automation rule ID
- operational_
insights_ strresource_ provider The namespace of workspaces resource provider- Microsoft.OperationalInsights.
- resource_
group_ strname The name of the resource group within the user's subscription. The name is case insensitive.
- workspace_
name str The name of the workspace.
- automation
Rule StringId Automation rule ID
- operational
Insights StringResource Provider The namespace of workspaces resource provider- Microsoft.OperationalInsights.
- resource
Group StringName The name of the resource group within the user's subscription. The name is case insensitive.
- workspace
Name String The name of the workspace.
getAutomationRule Result
The following output properties are available:
- Actions
List<Union<Pulumi.
Azure Native. Security Insights. Outputs. Automation Rule Modify Properties Action Response, Pulumi. Azure Native. Security Insights. Outputs. Automation Rule Run Playbook Action Response>> The actions to execute when the automation rule is triggered
- Created
By Pulumi.Azure Native. Security Insights. Outputs. Client Info Response Describes the client that created the automation rule
- Created
Time stringUtc The time the automation rule was created
- Display
Name string The display name of the automation rule
- Id string
Azure resource Id
- Last
Modified Pulumi.By Azure Native. Security Insights. Outputs. Client Info Response Describes the client that last updated the automation rule
- Last
Modified stringTime Utc The last time the automation rule was updated
- Name string
Azure resource name
- Order int
The order of execution of the automation rule
- Triggering
Logic Pulumi.Azure Native. Security Insights. Outputs. Automation Rule Triggering Logic Response 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
- Created
By ClientInfo Response Describes the client that created the automation rule
- Created
Time stringUtc The time the automation rule was created
- Display
Name string The display name of the automation rule
- Id string
Azure resource Id
- Last
Modified ClientBy Info Response Describes the client that last updated the automation rule
- Last
Modified stringTime Utc The last time the automation rule was updated
- Name string
Azure resource name
- Order int
The order of execution of the automation rule
- Triggering
Logic AutomationRule Triggering Logic Response The triggering logic of the automation rule
- Type string
Azure resource type
- Etag string
Etag of the azure resource
- actions
List<Either<Automation
Rule Modify Properties Action Response,Automation Rule Run Playbook Action Response>> The actions to execute when the automation rule is triggered
- created
By ClientInfo Response Describes the client that created the automation rule
- created
Time StringUtc The time the automation rule was created
- display
Name String The display name of the automation rule
- id String
Azure resource Id
- last
Modified ClientBy Info Response Describes the client that last updated the automation rule
- last
Modified StringTime Utc The last time the automation rule was updated
- name String
Azure resource name
- order Integer
The order of execution of the automation rule
- triggering
Logic AutomationRule Triggering Logic Response The triggering logic of the automation rule
- type String
Azure resource type
- etag String
Etag of the azure resource
- actions
(Automation
Rule Modify Properties Action Response | Automation Rule Run Playbook Action Response)[] The actions to execute when the automation rule is triggered
- created
By ClientInfo Response Describes the client that created the automation rule
- created
Time stringUtc The time the automation rule was created
- display
Name string The display name of the automation rule
- id string
Azure resource Id
- last
Modified ClientBy Info Response Describes the client that last updated the automation rule
- last
Modified stringTime Utc The last time the automation rule was updated
- name string
Azure resource name
- order number
The order of execution of the automation rule
- triggering
Logic AutomationRule Triggering Logic Response 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 ClientInfo Response Describes the client that created the automation rule
- created_
time_ strutc The time the automation rule was created
- display_
name str The display name of the automation rule
- id str
Azure resource Id
- last_
modified_ Clientby Info Response Describes the client that last updated the automation rule
- last_
modified_ strtime_ utc 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 AutomationRule Triggering Logic Response 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
- created
By Property Map Describes the client that created the automation rule
- created
Time StringUtc The time the automation rule was created
- display
Name String The display name of the automation rule
- id String
Azure resource Id
- last
Modified Property MapBy Describes the client that last updated the automation rule
- last
Modified StringTime Utc The last time the automation rule was updated
- name String
Azure resource name
- order Number
The order of execution of the automation rule
- triggering
Logic Property Map The triggering logic of the automation rule
- type String
Azure resource type
- etag String
Etag of the azure resource
Supporting Types
AutomationRuleModifyPropertiesActionResponse
- Action
Configuration Pulumi.Azure Native. Security Insights. Inputs. Automation Rule Modify Properties Action Response Action Configuration The configuration of the modify properties automation rule action
- Order int
The order of execution of the automation rule action
- Action
Configuration AutomationRule Modify Properties Action Response Action Configuration The configuration of the modify properties automation rule action
- Order int
The order of execution of the automation rule action
- action
Configuration AutomationRule Modify Properties Action Response Action Configuration The configuration of the modify properties automation rule action
- order Integer
The order of execution of the automation rule action
- action
Configuration AutomationRule Modify Properties Action Response Action Configuration The configuration of the modify properties automation rule action
- order number
The order of execution of the automation rule action
- action_
configuration AutomationRule Modify Properties Action Response Action Configuration The configuration of the modify properties automation rule action
- order int
The order of execution of the automation rule action
- action
Configuration 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
- Classification
Comment string Describes the reason the incident was closed
- Classification
Reason string The classification reason to close the incident with
- Labels
List<Pulumi.
Azure Native. Security Insights. Inputs. Incident Label Response> List of labels to add to the incident
- Owner
Pulumi.
Azure Native. Security Insights. Inputs. Incident Owner Info Response 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
- Classification
Comment string Describes the reason the incident was closed
- Classification
Reason string The classification reason to close the incident with
- Labels
[]Incident
Label Response List of labels to add to the incident
- Owner
Incident
Owner Info Response 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
- classification
Comment String Describes the reason the incident was closed
- classification
Reason String The classification reason to close the incident with
- labels
List<Incident
Label Response> List of labels to add to the incident
- owner
Incident
Owner Info Response 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
- classification
Comment string Describes the reason the incident was closed
- classification
Reason string The classification reason to close the incident with
- labels
Incident
Label Response[] List of labels to add to the incident
- owner
Incident
Owner Info Response 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[Incident
Label Response] List of labels to add to the incident
- owner
Incident
Owner Info Response 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
- classification
Comment String Describes the reason the incident was closed
- classification
Reason 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
- Condition
Properties Pulumi.Azure Native. Security Insights. Inputs. Automation Rule Property Values Condition Response Condition Properties The configuration of the automation rule condition
- Condition
Properties AutomationRule Property Values Condition Response Condition Properties The configuration of the automation rule condition
- condition
Properties AutomationRule Property Values Condition Response Condition Properties The configuration of the automation rule condition
- condition
Properties AutomationRule Property Values Condition Response Condition Properties The configuration of the automation rule condition
- condition_
properties AutomationRule Property Values Condition Response Condition Properties The configuration of the automation rule condition
- condition
Properties Property Map The configuration of the automation rule condition
AutomationRulePropertyValuesConditionResponseConditionProperties
- Operator string
The operator to use for evaluation the condition
- Property
Name string The property to evaluate
- Property
Values List<string> The values to use for evaluating the condition
- Operator string
The operator to use for evaluation the condition
- Property
Name string The property to evaluate
- Property
Values []string The values to use for evaluating the condition
- operator String
The operator to use for evaluation the condition
- property
Name String The property to evaluate
- property
Values List<String> The values to use for evaluating the condition
- operator string
The operator to use for evaluation the condition
- property
Name string The property to evaluate
- property
Values 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
- property
Name String The property to evaluate
- property
Values List<String> The values to use for evaluating the condition
AutomationRuleRunPlaybookActionResponse
- Action
Configuration Pulumi.Azure Native. Security Insights. Inputs. Automation Rule Run Playbook Action Response Action Configuration The configuration of the run playbook automation rule action
- Order int
The order of execution of the automation rule action
- Action
Configuration AutomationRule Run Playbook Action Response Action Configuration The configuration of the run playbook automation rule action
- Order int
The order of execution of the automation rule action
- action
Configuration AutomationRule Run Playbook Action Response Action Configuration The configuration of the run playbook automation rule action
- order Integer
The order of execution of the automation rule action
- action
Configuration AutomationRule Run Playbook Action Response Action Configuration The configuration of the run playbook automation rule action
- order number
The order of execution of the automation rule action
- action_
configuration AutomationRule Run Playbook Action Response Action Configuration The configuration of the run playbook automation rule action
- order int
The order of execution of the automation rule action
- action
Configuration Property Map The configuration of the run playbook automation rule action
- order Number
The order of execution of the automation rule action
AutomationRuleRunPlaybookActionResponseActionConfiguration
- Logic
App stringResource Id The resource id of the playbook resource
- Tenant
Id string The tenant id of the playbook resource
- Logic
App stringResource Id The resource id of the playbook resource
- Tenant
Id string The tenant id of the playbook resource
- logic
App StringResource Id The resource id of the playbook resource
- tenant
Id String The tenant id of the playbook resource
- logic
App stringResource Id The resource id of the playbook resource
- tenant
Id string The tenant id of the playbook resource
- logic_
app_ strresource_ id The resource id of the playbook resource
- tenant_
id str The tenant id of the playbook resource
- logic
App StringResource Id The resource id of the playbook resource
- tenant
Id String The tenant id of the playbook resource
AutomationRuleTriggeringLogicResponse
- Is
Enabled bool Determines whether the automation rule is enabled or disabled.
- Triggers
On string The type of object the automation rule triggers on
- Triggers
When string The type of event the automation rule triggers on
- Conditions
List<Pulumi.
Azure Native. Security Insights. Inputs. Automation Rule Property Values Condition Response> The conditions to evaluate to determine if the automation rule should be triggered on a given object
- Expiration
Time stringUtc 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 string The type of object the automation rule triggers on
- Triggers
When string The type of event the automation rule triggers on
- Conditions
[]Automation
Rule Property Values Condition Response The conditions to evaluate to determine if the automation rule should be triggered on a given object
- Expiration
Time stringUtc Determines when the automation rule should automatically expire and be disabled.
- is
Enabled Boolean Determines whether the automation rule is enabled or disabled.
- triggers
On String The type of object the automation rule triggers on
- triggers
When String The type of event the automation rule triggers on
- conditions
List<Automation
Rule Property Values Condition Response> The conditions to evaluate to determine if the automation rule should be triggered on a given object
- expiration
Time StringUtc Determines when the automation rule should automatically expire and be disabled.
- is
Enabled boolean Determines whether the automation rule is enabled or disabled.
- triggers
On string The type of object the automation rule triggers on
- triggers
When string The type of event the automation rule triggers on
- conditions
Automation
Rule Property Values Condition Response[] The conditions to evaluate to determine if the automation rule should be triggered on a given object
- expiration
Time stringUtc 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[Automation
Rule Property Values Condition Response] The conditions to evaluate to determine if the automation rule should be triggered on a given object
- expiration_
time_ strutc Determines when the automation rule should automatically expire and be disabled.
- is
Enabled Boolean Determines whether the automation rule is enabled or disabled.
- triggers
On String The type of object the automation rule triggers on
- triggers
When 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
- expiration
Time StringUtc 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.
- Object
Id string The object id of the client.
- User
Principal stringName The user principal name of the client.
- Email string
The email of the client.
- Name string
The name of the client.
- Object
Id string The object id of the client.
- User
Principal stringName The user principal name of the client.
- email String
The email of the client.
- name String
The name of the client.
- object
Id String The object id of the client.
- user
Principal StringName The user principal name of the client.
- email string
The email of the client.
- name string
The name of the client.
- object
Id string The object id of the client.
- user
Principal stringName 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_ strname The user principal name of the client.
- email String
The email of the client.
- name String
The name of the client.
- object
Id String The object id of the client.
- user
Principal StringName The user principal name of the client.
IncidentLabelResponse
- label_
name str The name of the label
- label_
type str The type of the label
IncidentOwnerInfoResponse
- Assigned
To string The name of the user the incident is assigned to.
- Email string
The email of the user the incident is assigned to.
- Object
Id string The object id of the user the incident is assigned to.
- User
Principal stringName The user principal name of the user the incident is assigned to.
- Assigned
To string The name of the user the incident is assigned to.
- Email string
The email of the user the incident is assigned to.
- Object
Id string The object id of the user the incident is assigned to.
- User
Principal stringName The user principal name of the user the incident is assigned to.
- assigned
To String The name of the user the incident is assigned to.
- email String
The email of the user the incident is assigned to.
- object
Id String The object id of the user the incident is assigned to.
- user
Principal StringName The user principal name of the user the incident is assigned to.
- assigned
To string The name of the user the incident is assigned to.
- email string
The email of the user the incident is assigned to.
- object
Id string The object id of the user the incident is assigned to.
- user
Principal stringName 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_ strname The user principal name of the user the incident is assigned to.
- assigned
To String The name of the user the incident is assigned to.
- email String
The email of the user the incident is assigned to.
- object
Id String The object id of the user the incident is assigned to.
- user
Principal StringName The user principal name of the user the incident is assigned to.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0