Compartilhar via


Communication Services - List Keys

Listar chaves
Obtenha as chaves de acesso do recurso CommunicationService.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/listKeys?api-version=2023-03-31

Parâmetros de URI

Nome Em Obrigatório Tipo Description
communicationServiceName
path True

string

O nome do recurso CommunicationService.

Padrão Regex: ^[-\w]+$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

uuid

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

CommunicationServiceKeys

Êxito. A resposta descreve as chaves de acesso do CommunicationService.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Exemplos

List keys

Solicitação de exemplo

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices/MyCommunicationResource/listKeys?api-version=2023-03-31

Resposta de exemplo

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Definições

Nome Description
CommunicationServiceKeys

Uma classe que representa as chaves de acesso de um CommunicationService.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

CommunicationServiceKeys

Uma classe que representa as chaves de acesso de um CommunicationService.

Nome Tipo Description
primaryConnectionString

string

CommunicationService cadeia de conexão construído por meio da primaryKey

primaryKey

string

A chave de acesso primária.

secondaryConnectionString

string

CommunicationService cadeia de conexão construído por meio da secondaryKey

secondaryKey

string

A chave de acesso secundária.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.