azure-native.security.getAutomation
Explore with Pulumi AI
Retrieves information about the model of a security automation. Azure REST API version: 2019-01-01-preview.
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>
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]
func LookupAutomation(ctx *Context, args *LookupAutomationArgs, opts ...InvokeOption) (*LookupAutomationResult, error)
func LookupAutomationOutput(ctx *Context, args *LookupAutomationOutputArgs, opts ...InvokeOption) LookupAutomationResultOutput
> 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)
}
public static CompletableFuture<GetAutomationResult> getAutomation(GetAutomationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:security:getAutomation
arguments:
# arguments dictionary
The following arguments are supported:
- Automation
Name string The security automation name.
- Resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- Automation
Name string The security automation name.
- Resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- automation
Name String The security automation name.
- resource
Group StringName The name of the resource group within the user's subscription. The name is case insensitive.
- automation
Name string The security automation name.
- resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- automation_
name str The security automation name.
- resource_
group_ strname The name of the resource group within the user's subscription. The name is case insensitive.
- automation
Name String The security automation name.
- resource
Group StringName The name of the resource group within the user's subscription. The name is case insensitive.
getAutomation Result
The following output properties are available:
- 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.
- Is
Enabled 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.
Azure Native. Security. Outputs. Automation Scope Response> 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.
Azure Native. Security. Outputs. Automation Source Response> A collection of the source event types which evaluate the security automation set of rules.
- Dictionary<string, string>
A list of key value pairs that describe 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.
- Is
Enabled bool Indicates whether the security automation is enabled.
- Kind string
Kind of the resource
- Location string
Location where the resource is stored
- Scopes
[]Automation
Scope Response 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
[]Automation
Source Response A collection of the source event types which evaluate the security automation set of rules.
- map[string]string
A list of key value pairs that describe 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.
- is
Enabled Boolean Indicates whether the security automation is enabled.
- kind String
Kind of the resource
- location String
Location where the resource is stored
- scopes
List<Automation
Scope Response> 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<Automation
Source Response> A collection of the source event types which evaluate the security automation set of rules.
- Map<String,String>
A list of key value pairs that describe the resource.
- id string
Resource Id
- name string
Resource name
- type string
Resource type
- actions
(Automation
Action Event Hub Response | Automation Action Logic App Response | Automation Action Workspace Response)[] 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.
- is
Enabled boolean Indicates whether the security automation is enabled.
- kind string
Kind of the resource
- location string
Location where the resource is stored
- scopes
Automation
Scope Response[] 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
Automation
Source Response[] A collection of the source event types which evaluate the security automation set of rules.
- {[key: string]: string}
A list of key value pairs that describe 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[Automation
Scope Response] 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[Automation
Source Response] A collection of the source event types which evaluate the security automation set of rules.
- Mapping[str, str]
A list of key value pairs that describe 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.
- is
Enabled 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.
- Map<String>
A list of key value pairs that describe the resource.
Supporting Types
AutomationActionEventHubResponse
- Sas
Policy stringName The target Event Hub SAS policy name.
- Connection
String string The target Event Hub connection string (it will not be included in any response).
- Event
Hub stringResource Id The target Event Hub Azure Resource ID.
- Sas
Policy stringName The target Event Hub SAS policy name.
- Connection
String string The target Event Hub connection string (it will not be included in any response).
- Event
Hub stringResource Id The target Event Hub Azure Resource ID.
- sas
Policy StringName The target Event Hub SAS policy name.
- connection
String String The target Event Hub connection string (it will not be included in any response).
- event
Hub StringResource Id The target Event Hub Azure Resource ID.
- sas
Policy stringName The target Event Hub SAS policy name.
- connection
String string The target Event Hub connection string (it will not be included in any response).
- event
Hub stringResource Id The target Event Hub Azure Resource ID.
- sas_
policy_ strname 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_ strresource_ id The target Event Hub Azure Resource ID.
- sas
Policy StringName The target Event Hub SAS policy name.
- connection
String String The target Event Hub connection string (it will not be included in any response).
- event
Hub StringResource Id The target Event Hub Azure Resource ID.
AutomationActionLogicAppResponse
- Logic
App stringResource Id 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 stringResource Id 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 StringResource Id 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 stringResource Id 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_ strresource_ id 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).
- logic
App StringResource Id 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
- Workspace
Resource stringId The fully qualified Log Analytics Workspace Azure Resource ID.
- Workspace
Resource stringId The fully qualified Log Analytics Workspace Azure Resource ID.
- workspace
Resource StringId The fully qualified Log Analytics Workspace Azure Resource ID.
- workspace
Resource stringId The fully qualified Log Analytics Workspace Azure Resource ID.
- workspace_
resource_ strid The fully qualified Log Analytics Workspace Azure Resource ID.
- workspace
Resource StringId The fully qualified Log Analytics Workspace Azure Resource ID.
AutomationRuleSetResponse
AutomationScopeResponse
- Description string
The resources scope description.
- Scope
Path 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.
- Scope
Path 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.
- scope
Path 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.
- scope
Path 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.
- scope
Path 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
- Event
Source string A valid event source type.
- Rule
Sets List<Pulumi.Azure Native. Security. Inputs. Automation Rule Set Response> A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
- Event
Source string A valid event source type.
- Rule
Sets []AutomationRule Set Response A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
- event
Source String A valid event source type.
- rule
Sets List<AutomationRule Set Response> A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
- event
Source string A valid event source type.
- rule
Sets AutomationRule Set Response[] 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[AutomationRule Set Response] A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
- event
Source String A valid event source type.
- rule
Sets List<Property Map> A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').
AutomationTriggeringRuleResponse
- Expected
Value string The expected value.
- Operator string
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
- Property
JPath string The JPath of the entity model property that should be checked.
- Property
Type string The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
- Expected
Value string The expected value.
- Operator string
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
- Property
JPath string The JPath of the entity model property that should be checked.
- Property
Type string The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
- expected
Value String The expected value.
- operator String
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
- property
JPath String The JPath of the entity model property that should be checked.
- property
Type String The data type of the compared operands (string, integer, floating point number or a boolean [true/false]]
- expected
Value string The expected value.
- operator string
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
- property
JPath string The JPath of the entity model property that should be checked.
- property
Type 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_ strpath 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]]
- expected
Value String The expected value.
- operator String
A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.
- property
JPath String The JPath of the entity model property that should be checked.
- property
Type 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