Edit

Share via

Set-AzAutomationCredential

  • Reference
Module:
Az.Automation

Modifies an Automation credential.

Syntax

Set-AzAutomationCredential
   [-Name] <String>
   [-Description <String>]
   [-Value <PSCredential>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Update a credential

$User = "Contoso\DChew"
$Password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $Password
Set-AzAutomationCredential -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.

Parameters

-AutomationAccountName

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
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

-Description

Specifies a description for the credential that this cmdlet modifies.

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

-Name

Specifies the name of the credential that this cmdlet modifies.

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

-ResourceGroupName

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

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

-Value

Specifies the credentials as a PSCredential object.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

PSCredential

Outputs

CredentialInfo