Set-AzAutomationAccount
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
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AssignUserIdentity
Assign the User Assigned Identities to this automation account
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AutomationServicesEncryption
Whether to set Automation Account KeySource to Microsoft.Automation or not.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisablePublicNetworkAccess
Whether to disable traffic on the non-ARM endpoints (Webhook/Agent) from the public internet
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyName
CMK KeyName
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyVaultEncryption
Whether to set Automation Account KeySource to Microsoft.KeyVault(enable CMK) or not.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyVaultUri
CMK KeyVaultUri
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyVersion
CMK KeyVersion
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 |
Required: | True |
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 |
Required: | False |
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 |
Required: | True |
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 |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UserIdentityEncryption
User Assigned Identity used for encryption
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |