< Back

Set-AzureRmAutomationVariable

Tue Jan 29, 2019 9:33 pm

NAME Set-AzureRmAutomationVariable



SYNOPSIS

Modifies an Automation variable.





SYNTAX

Set-AzureRmAutomationVariable [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] -Description <String> [<CommonParameters>]



Set-AzureRmAutomationVariable [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] -Encrypted <Boolean> -Value <Object> [<CommonParameters>]





DESCRIPTION

The Set-AzureRmAutomationVariable 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.





PARAMETERS

-AutomationAccountName <String>

Specifies the name of the Automation account in which the variable is stored.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

Specifies a description for the variable.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Encrypted <Boolean>

Specifies whether cmdlet encrypts the value of the variable for storage.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of the variable that this cmdlet modifies.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the resource group for which this cmdlet modifies a variable.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Value <Object>

Specifies a value for the variable.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Automation.Model.Variable







NOTES









Example 1: Set the value of a variable



PS C:\\>Set-AzureRmAutomationVariable -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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... onvariable

Get-AzureRmAutomationVariable

New-AzureRmAutomationVariable

Remove-AzureRmAutomationVariable