Get-AzCognitiveServicesAccountKey

  • Reference
Module:
Az.CognitiveServices

Gets the API keys for an account.

Syntax

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

Description

The Get-AzCognitiveServicesAccountKey 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-AzCognitiveServicesAccountKey to regenerate a key.

Examples

Example 1

Get-AzCognitiveServicesAccountKey -ResourceGroupName cognitive-services-resource-group -name myluis

Key1                             Key2
----                             ----
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Parameters

-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 the account. This cmdlet gets the keys for this account.

Type:String
Aliases:CognitiveServicesAccountName, AccountName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

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

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

Inputs

String

Outputs

PSCognitiveServicesAccountKeys