Set-AzAutomationAccount

Reference

Module:: Az.Automation

Modifies an Automation account.

Syntax

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

Set-AzAutomationAccount
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-Plan <String>]
   [-Tags <IDictionary>]
   [-AssignSystemIdentity]
   [-AssignUserIdentity <String[]>]
   [-KeyVaultEncryption]
   -KeyName <String>
   -KeyVersion <String>
   -KeyVaultUri <String>
   [-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 for use with other services like Azure KeyVault.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-AssignUserIdentity

Specifies the list of user assigned identities associated with the automation account. The user assigned identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'

Type:	String[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-AutomationServicesEncryption

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DisablePublicNetworkAccess

Whether to disable traffic on the non-ARM endpoints (Webhook/Agent) from the public internet and allow access only through private network.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyName

Automation Account encryption KeyVault KeyName

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVaultEncryption

Specify whether set Automation Account encryption keySource to Microsoft.KeyVault or not. If you specify KeyName, KeyVersion and KeyVaultUri, Automation Account Encryption KeySource will also be set to Microsoft.KeyVault whether this parameter is set or not.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVaultUri

Automation Account encryption KeyVault KeyVaultUri

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVersion

Automation Account encryption KeyVault KeyVersion

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

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

Type:	String
Aliases:	AutomationAccountName
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Plan

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

Basic
Free

Type:	String
Accepted values:	Free, Basic
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

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

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Tags

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

Type:	IDictionary
Aliases:	Tag
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-UserIdentityEncryption

User Assigned Identity associated with the account to be used for encryption. The user assigned identity reference will be ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

IDictionary

Outputs

AutomationAccount