Set-​Azure​Rm​Automation​Credential

Modifies an Automation credential.

Syntax

Set-AzureRmAutomationCredential
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-Name] <String>
   [-Description <String>]
   [-Value <PSCredential>]
   [<CommonParameters>]

Description

The Set-AzureRmAutomationCredential cmdlet modifies a credential as a PSCredential object in Azure Automation.

Examples

Example 1: Update a credential

PS C:\>$User = "Contoso\DChew"
PS C:\> $Password = ConvertTo-SecureString "Password" -AsPlainText -Force
PS C:\> $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $Password
PS C:\> Set-AzureRmAutomationCredential -AutomationAccountName "Contoso17" -Name "ContosoCredential" -ResourceGroupName "ResourceGroup01" -Value $Credential

The first command assigns a user name to the $User variable.

The second command converts a plain text password into a secure string by using the ConvertTo-SecureString cmdlet. The command stores that object in the $Password variable.

The third command creates a credential based on $User and $Password, and then stores it in the $Credential variable.

The final command modifies the Automation credential named ContosoCredential to use the credential in $Credential.

Required Parameters

-AutomationAccountName

Specifies the name of the Automation account for which this cmdlet modifies a credential.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of the credential that this cmdlet modifies.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group for which this cmdlet modifies a credential.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Description

Specifies a description for the credential that this cmdlet modifies.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Value

Specifies the credentials as a PSCredential object.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Automation.Model.CredentialInfo