1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getAutomation
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.security.getAutomation

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Retrieves information about the model of a security automation.

Uses Azure REST API version 2023-12-01-preview.

Other available API versions: 2019-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native security [ApiVersion]. See the version guide for details.

Using getAutomation

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 getAutomation(args: GetAutomationArgs, opts?: InvokeOptions): Promise<GetAutomationResult>
function getAutomationOutput(args: GetAutomationOutputArgs, opts?: InvokeOptions): Output<GetAutomationResult>
Copy
def get_automation(automation_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAutomationResult
def get_automation_output(automation_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAutomationResult]
Copy
func LookupAutomation(ctx *Context, args *LookupAutomationArgs, opts ...InvokeOption) (*LookupAutomationResult, error)
func LookupAutomationOutput(ctx *Context, args *LookupAutomationOutputArgs, opts ...InvokeOption) LookupAutomationResultOutput
Copy

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

public static class GetAutomation 
{
    public static Task<GetAutomationResult> InvokeAsync(GetAutomationArgs args, InvokeOptions? opts = null)
    public static Output<GetAutomationResult> Invoke(GetAutomationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAutomationResult> getAutomation(GetAutomationArgs args, InvokeOptions options)
public static Output<GetAutomationResult> getAutomation(GetAutomationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:security:getAutomation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AutomationName
This property is required.
Changes to this property will trigger replacement.
string
The security automation name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
AutomationName
This property is required.
Changes to this property will trigger replacement.
string
The security automation name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
automationName
This property is required.
Changes to this property will trigger replacement.
String
The security automation name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
automationName
This property is required.
Changes to this property will trigger replacement.
string
The security automation name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
automation_name
This property is required.
Changes to this property will trigger replacement.
str
The security automation name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
automationName
This property is required.
Changes to this property will trigger replacement.
String
The security automation name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.

getAutomation Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Name string
Resource name
Type string
Resource type
Actions List<object>
A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.
Description string
The security automation description.
Etag string
Entity tag is used for comparing two or more entities from the same requested resource.
IsEnabled bool
Indicates whether the security automation is enabled.
Kind string
Kind of the resource
Location string
Location where the resource is stored
Scopes List<Pulumi.AzureNative.Security.Outputs.AutomationScopeResponse>
A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.
Sources List<Pulumi.AzureNative.Security.Outputs.AutomationSourceResponse>
A collection of the source event types which evaluate the security automation set of rules.
Tags Dictionary<string, string>
A list of key value pairs that describe the resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Name string
Resource name
Type string
Resource type
Actions []interface{}
A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.
Description string
The security automation description.
Etag string
Entity tag is used for comparing two or more entities from the same requested resource.
IsEnabled bool
Indicates whether the security automation is enabled.
Kind string
Kind of the resource
Location string
Location where the resource is stored
Scopes []AutomationScopeResponse
A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.
Sources []AutomationSourceResponse
A collection of the source event types which evaluate the security automation set of rules.
Tags map[string]string
A list of key value pairs that describe the resource.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
name String
Resource name
type String
Resource type
actions List<Object>
A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.
description String
The security automation description.
etag String
Entity tag is used for comparing two or more entities from the same requested resource.
isEnabled Boolean
Indicates whether the security automation is enabled.
kind String
Kind of the resource
location String
Location where the resource is stored
scopes List<AutomationScopeResponse>
A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.
sources List<AutomationSourceResponse>
A collection of the source event types which evaluate the security automation set of rules.
tags Map<String,String>
A list of key value pairs that describe the resource.
azureApiVersion string
The Azure API version of the resource.
id string
Resource Id
name string
Resource name
type string
Resource type
actions (AutomationActionEventHubResponse | AutomationActionLogicAppResponse | AutomationActionWorkspaceResponse)[]
A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.
description string
The security automation description.
etag string
Entity tag is used for comparing two or more entities from the same requested resource.
isEnabled boolean
Indicates whether the security automation is enabled.
kind string
Kind of the resource
location string
Location where the resource is stored
scopes AutomationScopeResponse[]
A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.
sources AutomationSourceResponse[]
A collection of the source event types which evaluate the security automation set of rules.
tags {[key: string]: string}
A list of key value pairs that describe the resource.
azure_api_version str
The Azure API version of the resource.
id str
Resource Id
name str
Resource name
type str
Resource type
actions Sequence[Any]
A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.
description str
The security automation description.
etag str
Entity tag is used for comparing two or more entities from the same requested resource.
is_enabled bool
Indicates whether the security automation is enabled.
kind str
Kind of the resource
location str
Location where the resource is stored
scopes Sequence[AutomationScopeResponse]
A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.
sources Sequence[AutomationSourceResponse]
A collection of the source event types which evaluate the security automation set of rules.
tags Mapping[str, str]
A list of key value pairs that describe the resource.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
name String
Resource name
type String
Resource type
actions List<Property Map | Property Map | Property Map>
A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.
description String
The security automation description.
etag String
Entity tag is used for comparing two or more entities from the same requested resource.
isEnabled Boolean
Indicates whether the security automation is enabled.
kind String
Kind of the resource
location String
Location where the resource is stored
scopes List<Property Map>
A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.
sources List<Property Map>
A collection of the source event types which evaluate the security automation set of rules.
tags Map<String>
A list of key value pairs that describe the resource.

Supporting Types

AutomationActionEventHubResponse

SasPolicyName This property is required. string
The target Event Hub SAS policy name.
ConnectionString string
The target Event Hub connection string (it will not be included in any response).
EventHubResourceId string
The target Event Hub Azure Resource ID.
IsTrustedServiceEnabled bool
Indicates whether the trusted service is enabled or not.
SasPolicyName This property is required. string
The target Event Hub SAS policy name.
ConnectionString string
The target Event Hub connection string (it will not be included in any response).
EventHubResourceId string
The target Event Hub Azure Resource ID.
IsTrustedServiceEnabled bool
Indicates whether the trusted service is enabled or not.
sasPolicyName This property is required. String
The target Event Hub SAS policy name.
connectionString String
The target Event Hub connection string (it will not be included in any response).
eventHubResourceId String
The target Event Hub Azure Resource ID.
isTrustedServiceEnabled Boolean
Indicates whether the trusted service is enabled or not.
sasPolicyName This property is required. string
The target Event Hub SAS policy name.
connectionString string
The target Event Hub connection string (it will not be included in any response).
eventHubResourceId string
The target Event Hub Azure Resource ID.
isTrustedServiceEnabled boolean
Indicates whether the trusted service is enabled or not.
sas_policy_name This property is required. str
The target Event Hub SAS policy name.
connection_string str
The target Event Hub connection string (it will not be included in any response).
event_hub_resource_id str
The target Event Hub Azure Resource ID.
is_trusted_service_enabled bool
Indicates whether the trusted service is enabled or not.
sasPolicyName This property is required. String
The target Event Hub SAS policy name.
connectionString String
The target Event Hub connection string (it will not be included in any response).
eventHubResourceId String
The target Event Hub Azure Resource ID.
isTrustedServiceEnabled Boolean
Indicates whether the trusted service is enabled or not.

AutomationActionLogicAppResponse

LogicAppResourceId string
The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App
Uri string
The Logic App trigger URI endpoint (it will not be included in any response).
LogicAppResourceId string
The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App
Uri string
The Logic App trigger URI endpoint (it will not be included in any response).
logicAppResourceId String
The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App
uri String
The Logic App trigger URI endpoint (it will not be included in any response).
logicAppResourceId string
The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App
uri string
The Logic App trigger URI endpoint (it will not be included in any response).
logic_app_resource_id str
The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App
uri str
The Logic App trigger URI endpoint (it will not be included in any response).
logicAppResourceId String
The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App
uri String
The Logic App trigger URI endpoint (it will not be included in any response).

AutomationActionWorkspaceResponse

WorkspaceResourceId string
The fully qualified Log Analytics Workspace Azure Resource ID.
WorkspaceResourceId string
The fully qualified Log Analytics Workspace Azure Resource ID.
workspaceResourceId String
The fully qualified Log Analytics Workspace Azure Resource ID.
workspaceResourceId string
The fully qualified Log Analytics Workspace Azure Resource ID.
workspace_resource_id str
The fully qualified Log Analytics Workspace Azure Resource ID.
workspaceResourceId String
The fully qualified Log Analytics Workspace Azure Resource ID.

AutomationRuleSetResponse

AutomationScopeResponse

Description string
The resources scope description.
ScopePath string
The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs).
Description string
The resources scope description.
ScopePath string
The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs).
description String
The resources scope description.
scopePath String
The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs).
description string
The resources scope description.
scopePath string
The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs).
description str
The resources scope description.
scope_path str
The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs).
description String
The resources scope description.
scopePath String
The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs).

AutomationSourceResponse

EventSource string
A valid event source type.
RuleSets List<Pulumi.AzureNative.Security.Inputs.AutomationRuleSetResponse>
A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
EventSource string
A valid event source type.
RuleSets []AutomationRuleSetResponse
A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
eventSource String
A valid event source type.
ruleSets List<AutomationRuleSetResponse>
A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
eventSource string
A valid event source type.
ruleSets AutomationRuleSetResponse[]
A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
event_source str
A valid event source type.
rule_sets Sequence[AutomationRuleSetResponse]
A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
eventSource String
A valid event source type.
ruleSets List<Property Map>
A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').

AutomationTriggeringRuleResponse

ExpectedValue string
The expected value.
Operator string
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
PropertyJPath string
The JPath of the entity model property that should be checked.
PropertyType string
The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
ExpectedValue string
The expected value.
Operator string
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
PropertyJPath string
The JPath of the entity model property that should be checked.
PropertyType string
The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
expectedValue String
The expected value.
operator String
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
propertyJPath String
The JPath of the entity model property that should be checked.
propertyType String
The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
expectedValue string
The expected value.
operator string
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
propertyJPath string
The JPath of the entity model property that should be checked.
propertyType string
The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
expected_value str
The expected value.
operator str
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
property_j_path str
The JPath of the entity model property that should be checked.
property_type str
The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
expectedValue String
The expected value.
operator String
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
propertyJPath String
The JPath of the entity model property that should be checked.
propertyType String
The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi