azure-native.securityinsights.getAutomationRule
Explore with Pulumi AI
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, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-09-01, 2024-10-01-preview, 2025-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,
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)
public static Output<GetAutomationRuleResult> getAutomationRule(GetAutomationRuleArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:securityinsights:getAutomationRule
arguments:
# arguments dictionary
The following arguments are supported:
- Automation
Rule stringId - Automation rule ID
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Workspace
Name string - The name of the workspace.
- Automation
Rule stringId - Automation rule ID
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Workspace
Name string - The name of the workspace.
- automation
Rule StringId - Automation rule ID
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- workspace
Name String - The name of the workspace.
- automation
Rule stringId - Automation rule ID
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- workspace
Name string - The name of the workspace.
- automation_
rule_ strid - Automation rule ID
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- workspace_
name str - The name of the workspace.
- automation
Rule StringId - Automation rule ID
- resource
Group StringName - The name of the resource group. 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 - Information on the client (user or application) that made some action
- Created
Time stringUtc - The time the automation rule was created.
- Display
Name string - The display name of the automation rule.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Last
Modified Pulumi.By Azure Native. Security Insights. Outputs. Client Info Response - Information on the client (user or application) that made some action
- Last
Modified stringTime Utc - 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.
- System
Data Pulumi.Azure Native. Security Insights. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Triggering
Logic Pulumi.Azure Native. Security Insights. Outputs. Automation Rule Triggering Logic Response - 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.
- Created
By ClientInfo Response - Information on the client (user or application) that made some action
- Created
Time stringUtc - The time the automation rule was created.
- Display
Name string - The display name of the automation rule.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Last
Modified ClientBy Info Response - Information on the client (user or application) that made some action
- Last
Modified stringTime Utc - 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.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Triggering
Logic AutomationRule Triggering Logic Response - 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<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 - Information on the client (user or application) that made some action
- created
Time StringUtc - The time the automation rule was created.
- display
Name String - The display name of the automation rule.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last
Modified ClientBy Info Response - Information on the client (user or application) that made some action
- last
Modified StringTime Utc - 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.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- triggering
Logic AutomationRule Triggering Logic Response - 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
(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 - Information on the client (user or application) that made some action
- created
Time stringUtc - The time the automation rule was created.
- display
Name string - The display name of the automation rule.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last
Modified ClientBy Info Response - Information on the client (user or application) that made some action
- last
Modified stringTime Utc - 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.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- triggering
Logic AutomationRule Triggering Logic Response - 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 ClientInfo Response - Information on the client (user or application) that made some action
- created_
time_ strutc - 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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last_
modified_ Clientby Info Response - Information on the client (user or application) that made some action
- last_
modified_ strtime_ utc - 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 SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- triggering_
logic AutomationRule Triggering Logic Response - 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.
- created
By Property Map - Information on the client (user or application) that made some action
- created
Time StringUtc - The time the automation rule was created.
- display
Name String - The display name of the automation rule.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- last
Modified Property MapBy - Information on the client (user or application) that made some action
- last
Modified StringTime Utc - 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.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- triggering
Logic 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
- Array
Type string - Change
Type string
- Array
Type string - Change
Type string
- array
Type String - change
Type String
- array
Type string - change
Type string
- array_
type str - change_
type str
- array
Type String - change
Type String
AutomationRulePropertyValuesChangedConditionResponse
- Change
Type string - Operator string
- Property
Name string - Property
Values List<string>
- Change
Type string - Operator string
- Property
Name string - Property
Values []string
- change
Type String - operator String
- property
Name String - property
Values List<String>
- change
Type string - operator string
- property
Name string - property
Values string[]
- change_
type str - operator str
- property_
name str - property_
values Sequence[str]
- change
Type String - operator String
- property
Name String - property
Values List<String>
AutomationRulePropertyValuesConditionResponse
- Operator string
- Property
Name string - The property to evaluate in an automation rule property condition.
- Property
Values List<string>
- Operator string
- Property
Name string - The property to evaluate in an automation rule property condition.
- Property
Values []string
- operator String
- property
Name String - The property to evaluate in an automation rule property condition.
- property
Values List<String>
- operator string
- property
Name string - The property to evaluate in an automation rule property condition.
- property
Values string[]
- operator str
- property_
name str - The property to evaluate in an automation rule property condition.
- property_
values Sequence[str]
- operator String
- property
Name String - The property to evaluate in an automation rule property condition.
- property
Values List<String>
AutomationRuleRunPlaybookActionResponse
AutomationRuleTriggeringLogicResponse
- Is
Enabled bool - Determines whether the automation rule is enabled or disabled.
- Triggers
On string - Triggers
When string - Conditions List<object>
- 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 - Triggers
When string - Conditions []interface{}
- 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 - triggers
When String - conditions List<Object>
- 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 - triggers
When string - conditions
(Property
Array Changed Condition Properties Response | Property Changed Condition Properties Response | Property Condition Properties 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 - triggers_
when str - conditions
Sequence[Union[Property
Array Changed Condition Properties Response, Property Changed Condition Properties Response, Property Condition Properties 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 - triggers
When 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.
- 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.
- Owner
Type string - The type of the owner 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.
- Owner
Type string - The type of the owner 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.
- owner
Type String - The type of the owner 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.
- owner
Type string - The type of the owner 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.
- owner_
type str - The type of the owner 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.
- owner
Type String - The type of the owner the incident is assigned to.
- user
Principal StringName - The user principal name of the user the incident is assigned to.
IncidentPropertiesActionResponse
- Classification string
- The reason the incident was closed
- Classification
Comment string - Describes the reason the incident was closed.
- Classification
Reason string - The classification reason the incident was closed 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 - 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
- Classification
Comment string - Describes the reason the incident was closed.
- Classification
Reason string - The classification reason the incident was closed with
- Labels
[]Incident
Label Response - List of labels to add to the incident.
- Owner
Incident
Owner Info Response - 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
- classification
Comment String - Describes the reason the incident was closed.
- classification
Reason String - The classification reason the incident was closed with
- labels
List<Incident
Label Response> - List of labels to add to the incident.
- owner
Incident
Owner Info Response - 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
- classification
Comment string - Describes the reason the incident was closed.
- classification
Reason string - The classification reason the incident was closed with
- labels
Incident
Label Response[] - List of labels to add to the incident.
- owner
Incident
Owner Info Response - 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[Incident
Label Response] - List of labels to add to the incident.
- owner
Incident
Owner Info Response - 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
- classification
Comment String - Describes the reason the incident was closed.
- classification
Reason 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
- 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.
PropertyArrayChangedConditionPropertiesResponse
PropertyChangedConditionPropertiesResponse
PropertyConditionPropertiesResponse
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0