Accounts - Regenerate Keys

Serviço:

Maps Management

Versão da API:

2023-06-01

Regenerar a chave primária ou secundária para uso com as APIs de Mapas. A chave antiga deixará de funcionar imediatamente.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	O nome da Conta de Mapas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
keyType	True	KeyType	Se a operação se refere à chave primária ou secundária.

Respostas

Nome	Tipo	Description
200 OK	MapsAccountKeys	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Regenerate Key

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount/regenerateKey?api-version=2023-06-01

{
  "keyType": "primary"
}

Resposta de exemplo

Código de status:

200

{
  "primaryKey": "<primaryKey>",
  "primaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z",
  "secondaryKey": "<secondaryKey>",
  "secondaryKeyLastUpdated": "2021-07-02T01:01:01.1075056Z"
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
KeyType	Se a operação se refere à chave primária ou secundária.
MapsAccountKeys	O conjunto de chaves que pode ser usado para acessar as APIs REST dos Mapas. Duas chaves são fornecidas para rotação de chave sem interrupção.
MapsKeySpecification	Se a operação se refere à chave primária ou secundária.

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

KeyType

Enumeração

Se a operação se refere à chave primária ou secundária.

Valor	Description
primary
secondary

MapsAccountKeys

Objeto

O conjunto de chaves que pode ser usado para acessar as APIs REST dos Mapas. Duas chaves são fornecidas para rotação de chave sem interrupção.

Nome	Tipo	Description
primaryKey	string	A chave primária para acessar as APIs REST dos Mapas.
primaryKeyLastUpdated	string	A última data e hora atualizadas da chave primária.
secondaryKey	string	A chave secundária para acessar as APIs REST dos Mapas.
secondaryKeyLastUpdated	string	A última data e hora atualizadas da chave secundária.

MapsKeySpecification

Objeto

Se a operação se refere à chave primária ou secundária.

Nome	Tipo	Description
keyType	KeyType	Se a operação se refere à chave primária ou secundária.