Confirm-AzSecurityAutomation

Module:

Az.Security Module

Validates the security automation model before create or update. Any validation errors are returned to the client

Syntax

ResourceGroupLevelResource (Default)

Confirm-AzSecurityAutomation
    -ResourceGroupName <String>
    -Name <String>
    -Location <String>
    -Scope <PSSecurityAutomationScope[]>
    -Source <PSSecurityAutomationSource[]>
    -Action <PSSecurityAutomationAction[]>
    [-Etag <String>]
    [-Tag <Hashtable>]
    [-Description <String>]
    [-IsEnabled <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceId

Confirm-AzSecurityAutomation
    -ResourceId <String>
    -Location <String>
    -Scope <PSSecurityAutomationScope[]>
    -Source <PSSecurityAutomationSource[]>
    -Action <PSSecurityAutomationAction[]>
    [-Etag <String>]
    [-Tag <Hashtable>]
    [-Description <String>]
    [-IsEnabled <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

InputObject

Confirm-AzSecurityAutomation
    -Action <PSSecurityAutomationAction[]>
    -InputObject <PSSecurityAutomation>
    [-Location <String>]
    [-Etag <String>]
    [-Tag <Hashtable>]
    [-Description <String>]
    [-IsEnabled <Boolean>]
    [-Scope <PSSecurityAutomationScope[]>]
    [-Source <PSSecurityAutomationSource[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Validates the security automation model before create or update. Any validation errors are returned to the client

Examples

Example 1

Confirm-AzSecurityAutomation -Name 'SampleAutomation' -ResourceGroupName 'SampleResourceGroup' -Description 'Sample security automation' -Scope $scopes -Source $sources -Action $actions

Validates that the creation of security automation named "SampleAutomation" under resource group named "SampleResourceGroup"

Parameters

-Action

A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true

Parameter properties

Type:	PSSecurityAutomationAction[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Description

The security automation description

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Etag

Entity tag is used for comparing two or more entities from the same requested resource

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Input Object.

Parameter properties

Type:	PSSecurityAutomation
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

InputObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-IsEnabled

Is rule enabled.

Parameter properties

Type:	Nullable<T>[Boolean]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Location

Location.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceGroupLevelResource

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Resource name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceGroupLevelResource

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceGroupLevelResource

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

ID of the security resource that you want to invoke the command on.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Scope

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

Parameter properties

Type:	PSSecurityAutomationScope[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceGroupLevelResource

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Source

A collection of the source event types which evaluate the security automation set of rules

Parameter properties

Type:	PSSecurityAutomationSource[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceGroupLevelResource

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Tag

Tags.

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

PSSecurityAutomation

Outputs

Boolean