Edit

Share via


New-AzAutomationAccount

Creates an Automation account.

Syntax

AutomationServicesEncryption (Default)

New-AzAutomationAccount
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-Location] <String>
    [-Plan <String>]
    [-Tags <IDictionary>]
    [-AssignSystemIdentity]
    [-AssignUserIdentity <String[]>]
    [-AutomationServicesEncryption]
    [-DisablePublicNetworkAccess]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

KeyVaultEncryption

New-AzAutomationAccount
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-Location] <String>
    -KeyName <String>
    -KeyVersion <String>
    -KeyVaultUri <String>
    [-Plan <String>]
    [-Tags <IDictionary>]
    [-AssignSystemIdentity]
    [-AssignUserIdentity <String[]>]
    [-KeyVaultEncryption]
    [-UserIdentityEncryption <String>]
    [-DisablePublicNetworkAccess]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The New-AzAutomationAccount cmdlet creates an Azure Automation account in a resource group. An Automation account is a container for Automation resources that is isolated from the resources of other Automation accounts. Automation resources include runbooks, Desired State Configuration (DSC) configurations, jobs, and assets.

Examples

Example 1: Create an automation account

New-AzAutomationAccount -Name "ContosoAutomationAccount" -Location "East US" -ResourceGroupName "ResourceGroup01"

This command creates a new automation account named ContosoAutomationAccount in the East US region.

Example 2

Creates an Automation account. (autogenerated)

New-AzAutomationAccount -Location 'East US' -Name 'ContosoAutomationAccount' -ResourceGroupName 'ResourceGroup01' -Tags <IDictionary>

Parameters

-AssignSystemIdentity

Generate and assign a new System Identity for this automation account

Parameter properties

Type:SwitchParameter
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

-AssignUserIdentity

Assign the User Assigned Identities to this automation account

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

-AutomationServicesEncryption

Specify whether set Automation Account KeySource to Microsoft.Automation or not.

Parameter properties

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

Parameter sets

AutomationServicesEncryption
Position:Named
Mandatory:False
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

-DisablePublicNetworkAccess

Whether to disable traffic on the non-ARM endpoints (Webhook/Agent) from the public internet

Parameter properties

Type:SwitchParameter
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

-KeyName

CMK KeyName

Parameter properties

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

Parameter sets

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

-KeyVaultEncryption

Specify whether set Automation Account KeySource to Microsoft.KeyVault (enable CMK) or not.

Parameter properties

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

Parameter sets

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

-KeyVaultUri

CMK KeyVaultUri

Parameter properties

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

Parameter sets

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

-KeyVersion

CMK KeyVersion

Parameter properties

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

Parameter sets

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

-Location

Specifies the ___location in which this cmdlet creates the Automation account. To obtain valid locations, use the Get-AzLocation cmdlet.

Parameter properties

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

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies a name for the Automation account.

Parameter properties

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

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Plan

Specifies the plan for the Automation account. Valid values are:

  • Basic
  • Free

Parameter properties

Type:String
Default value:None
Accepted values:Free, Basic
Supports wildcards:False
DontShow:False

Parameter sets

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

-ResourceGroupName

Specifies the name of a resource group to which this cmdlet adds an Automation account.

Parameter properties

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

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Tags

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Tag

Parameter sets

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

-UserIdentityEncryption

User Assigned Identity used for encryption

Parameter properties

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

Parameter sets

KeyVaultEncryption
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

IDictionary

Outputs

AutomationAccount