Get-AzCognitiveServicesAccountKey

Module:: Az.CognitiveServices Module

Gets the API keys for an account.

Syntax

Default (Default)

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

-Name

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	CognitiveServicesAccountName, AccountName

Parameter sets

-ResourceGroupName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

URL: https://learn.microsoft.com/en-us/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountkey?view=azps-16.0.0