Get-AzAutomationCredential

  • Reference
Module:
Az.Automation

Gets Automation credentials.

Syntax

Get-AzAutomationCredential
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationCredential
   [-Name] <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzAutomationCredential cmdlet gets one or more Azure Automation credentials. By default, all credentials are returned. Specify the name of a credential to get a specific credential. For security purposes, this cmdlet does not return credential passwords.

Examples

Example 1: Get all credentials

Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17"

This command gets metadata for all credentials in the Automation account named Contoso17.

Example 2: Get a credential

Get-AzAutomationCredential -ResourceGroupName "ResourceGroup01" -AutomationAccountName "Contoso17" -Name "ContosoCredential"

This command gets metadata for the credential named ContosoCredential in the Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of the Automation account for which this cmdlet retrieves credentials.

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

-Name

Specifies the name of a credential to retrieve.

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

-ResourceGroupName

Specifies the resource group for which this cmdlet retrieves credentials.

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

Inputs

String

Outputs

CredentialInfo