Get-AzureRmCognitiveServicesAccountKey

Gets the API keys for an account.

Syntax

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

Description

The Get-AzureRmCognitiveServicesAccountKey cmdlet gets the API keys for a provisioned Cognitive Services account.

A Cognitive Services account has two API keys: Key1 and Key2. The keys enable interaction with the Cognitive Services account endpoint.

Use New-AzureRmCognitiveServicesAccountKey to regenerate a key.

Examples

1:

Required Parameters

-Name

Specifies the name of the account. This cmdlet gets the keys for this account.

Type:String
Aliases:CognitiveServicesAccountName, AccountName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group the account is assigned to.

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

Optional Parameters

-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Management.CognitiveServices.Models.PSCognitiveServicesAccountKeys