Accounts - List Keys

Lists the account keys for the specified Cognitive Services account.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys?api-version=2023-05-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The name of Cognitive Services account.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

ApiKeys

Returns with a response body containing the subscription keys for the resource: key1 The first API key for authentication when client calls the API endpoint.

key2 The second API key for authentication when client calls the API endpoint.

Other Status Codes

ErrorResponse

Error response describing why the operation failed

Examples

List Keys

Sample Request

POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/listKeys?api-version=2023-05-01

Sample Response

{
  "key1": "KEY1",
  "key2": "KEY2"
}

Definitions

Name Description
ApiKeys

The access keys for the cognitive services account.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ApiKeys

The access keys for the cognitive services account.

Name Type Description
key1

string

Gets the value of key 1.

key2

string

Gets the value of key 2.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.