Set-AzAutomationVariable
Modifies an Automation variable.
Syntax
UpdateVariableValue
Set-AzAutomationVariable
[-Name] <String>
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
-Encrypted <Boolean>
-Value <Object>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
UpdateVariableDescription
Set-AzAutomationVariable
[-Name] <String>
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
-Description <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Set-AzAutomationVariable cmdlet modifies the value or description of a variable in Azure Automation.
To encrypt the variable, specify the Encrypted parameter.
You cannot modify the encrypted state of a variable after creation.
Specifying Encrypted for an existing, non-encrypted, variable fails.
Examples
Example 1: Set the value of a variable
Set-AzAutomationVariable -AutomationAccountName "Contoso17" -Name "StringVariable22" -ResourceGroupName "ResourceGroup01" -Value "New Value" -Encrypted $False
This command sets a new value for the variable named StringVariable22 in the Azure Automation account named Contoso17.
Parameters
-AutomationAccountName
Specifies the name of the Automation account in which the variable is stored.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True 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
Specifies a description for the variable.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateVariableDescription
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Encrypted
Specifies whether cmdlet encrypts the value of the variable for storage.
Parameter properties
Type: Boolean
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateVariableValue
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Name
Specifies the name of the variable that this cmdlet modifies.
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
-ResourceGroupName
Specifies the resource group for which this cmdlet modifies a variable.
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
-Value
Specifies a value for the variable.
Parameter properties
Type: Object
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateVariableValue
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True 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 .
Outputs
