Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Set-AzAutomationAccount

Modifies an Automation account.

Syntax

AutomationServicesEncryption (Default)

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

KeyVaultEncryption

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

Description

The Set-AzAutomationAccount cmdlet modifies an Azure Automation account. For more information about Automation accounts, see the New-AzAutomationAccount cmdlet.

Examples

Example 1: Set the tags for an Automation account

$Tags = @{"tag01"="value01";"tag02"="value02"}
Set-AzAutomationAccount -Name "AutomationAccount01" -ResourceGroupName "ResourceGroup01" -Tags $Tags

The first command assigns two key/value pairs to the $Tags variable. The second command sets tags in $Tags for the Automation account named AutomationAccount01.

Example 2: Change the plan for an Automation account

Set-AzAutomationAccount -Name "AutomationAccount01" -ResourceGroupName "ResourceGroup01" -Plan Basic

This command changes the plan to Basic for the Automation account named AutomationAccount01.

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

-AssignUserIdentity

Assign the User Assigned Identities to this automation account

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-AutomationServicesEncryption

Whether to set Automation Account KeySource to Microsoft.Automation or not.

Parameter properties

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

Parameter sets

-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

-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

-KeyName

CMK KeyName

Parameter properties

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

Parameter sets

-KeyVaultEncryption

Whether to 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

-KeyVaultUri

CMK KeyVaultUri

Parameter properties

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

Parameter sets

-KeyVersion

CMK KeyVersion

Parameter properties

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

Parameter sets

-Name

Specifies the name of the Automation account that this cmdlet modifies.

Parameter properties

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

Parameter sets

-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

-ResourceGroupName

Specifies the name of a resource group that contains the Automation account that this cmdlet modifies.

Parameter properties

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

Parameter sets

-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

-UserIdentityEncryption

User Assigned Identity used for encryption

Parameter properties

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

Parameter sets

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

Related Links


Feedback

Was this page helpful?