Compartilhar via


Communication Services - Regenerate Key

Regenerar chave
Regenerar a chave de acesso do CommunicationService. PrimaryKey e SecondaryKey não podem ser regenerados ao mesmo tempo.

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

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 não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

uuid

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

api-version
query True

string

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

Corpo da solicitação

Nome Tipo Description
keyType

KeyType

O keyType a ser regenerado. Deve ser 'primário' ou 'secundário'(não diferencia maiúsculas de minúsculas).

Respostas

Nome Tipo Description
200 OK

CommunicationServiceKeys

A solicitação de chave regenerada foi concluída com êxito. A resposta contém a nova chave.

Other Status Codes

ErrorResponse

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

Exemplos

Regenerate key

Solicitação de exemplo

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

{
  "keyType": "Primary"
}

Resposta de exemplo

{
  "primaryKey": "1234",
  "primaryConnectionString": "endpoint=http://example.com;accesskey=1234"
}

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

O detalhe do erro.

ErrorResponse

Resposta de erro

KeyType

O keyType a ser regenerado. Deve ser 'primário' ou 'secundário'(não diferencia maiúsculas de minúsculas).

RegenerateKeyParameters

Parâmetros descrevem a solicitação para regenerar chaves de acesso

CommunicationServiceKeys

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

Nome Tipo Description
primaryConnectionString

string

Cadeia de conexão CommunicationService construída por meio da primaryKey

primaryKey

string

A chave de acesso primária.

secondaryConnectionString

string

Cadeia de conexão CommunicationService construída 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

O detalhe 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.

KeyType

O keyType a ser regenerado. Deve ser 'primário' ou 'secundário'(não diferencia maiúsculas de minúsculas).

Nome Tipo Description
Primary

string

Secondary

string

RegenerateKeyParameters

Parâmetros descrevem a solicitação para regenerar chaves de acesso

Nome Tipo Description
keyType

KeyType

O keyType a ser regenerado. Deve ser 'primário' ou 'secundário'(não diferencia maiúsculas de minúsculas).