Skip to content

Latest commit

 

History

History
136 lines (100 loc) · 3.51 KB

File metadata and controls

136 lines (100 loc) · 3.51 KB
external help file ms.assetid online version schema
Microsoft.Azure.Commands.ResourceManager.Automation.dll-Help.xml
D6325A22-2D1B-4228-A5BC-3F1071E26FB2
2.0.0

Set-AzureRmAutomationCredential

SYNOPSIS

Modifies an Automation credential.

SYNTAX

Set-AzureRmAutomationCredential [-Name] <String> [-Description <String>] [-Value <PSCredential>]
 [-ResourceGroupName] <String> [-AutomationAccountName] <String> [<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.

PARAMETERS

-AutomationAccountName

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

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

Specifies a description for the credential that this cmdlet modifies.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
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
Parameter Sets: (All)
Aliases: 

Required: True
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
Parameter Sets: (All)
Aliases: 

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

-Value

Specifies the credentials as a PSCredential object.

Type: PSCredential
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

Microsoft.Azure.Commands.Automation.Model.CredentialInfo

NOTES

RELATED LINKS

Get-AzureRmAutomationCredential

New-AzureRmAutomationCredential

Remove-AzureRmAutomationCredential