Communication Services - Regenerate Key
Regenerar chave
Regenere 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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
communication
|
path | True |
string |
O nome do recurso CommunicationService. Padrão Regex: |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas. |
subscription
|
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. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
keyType |
O keyType para regenerar. Deve ser «primário» ou «secundário» (sem distinção entre maiúsculas e minúsculas). |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
A solicitação de chave regenerada foi concluída com êxito. A resposta contém a nova chave. |
|
Other Status Codes |
Resposta de erro descrevendo por que a operação falhou. |
Exemplos
Regenerate key
Pedido de amostra
Resposta da amostra
{
"primaryKey": "1234",
"primaryConnectionString": "endpoint=http://example.com;accesskey=1234"
}
Definições
Name | Description |
---|---|
Communication |
Uma classe que representa as chaves de acesso de um CommunicationService. |
Error |
O erro de gerenciamento de recursos informações adicionais. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Key |
O keyType para regenerar. Deve ser «primário» ou «secundário» (sem distinção entre maiúsculas e minúsculas). |
Regenerate |
Parâmetros descreve a solicitação para regenerar chaves de acesso |
CommunicationServiceKeys
Uma classe que representa as chaves de acesso de um CommunicationService.
Name | 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 através da secondaryKey |
secondaryKey |
string |
A chave de acesso secundária. |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
O erro informações adicionais. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
KeyType
O keyType para regenerar. Deve ser «primário» ou «secundário» (sem distinção entre maiúsculas e minúsculas).
Name | Tipo | Description |
---|---|---|
Primary |
string |
|
Secondary |
string |
RegenerateKeyParameters
Parâmetros descreve a solicitação para regenerar chaves de acesso
Name | Tipo | Description |
---|---|---|
keyType |
O keyType para regenerar. Deve ser «primário» ou «secundário» (sem distinção entre maiúsculas e minúsculas). |