Accounts - Regenerate Keys

Service:

Maps Management

Version d'API:

2023-06-01

Régénérez la clé primaire ou secondaire à utiliser avec les API Maps. L’ancienne clé cessera de fonctionner immédiatement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte Maps.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
keyType	True	KeyType	Indique si l’opération fait référence à la clé primaire ou secondaire.

Réponses

Nom	Type	Description
200 OK	MapsAccountKeys	La demande a été réalisée avec succès.
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Regenerate Key

Exemple de requête

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"
}

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
KeyType	Indique si l’opération fait référence à la clé primaire ou secondaire.
MapsAccountKeys	Ensemble de clés qui peuvent être utilisées pour accéder aux API REST Cartes. Deux clés sont fournies pour la rotation des clés sans interruption.
MapsKeySpecification	Indique si l’opération fait référence à la clé primaire ou secondaire.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

KeyType

Énumération

Indique si l’opération fait référence à la clé primaire ou secondaire.

Valeur	Description
primary
secondary

MapsAccountKeys

Object

Ensemble de clés qui peuvent être utilisées pour accéder aux API REST Cartes. Deux clés sont fournies pour la rotation des clés sans interruption.

Nom	Type	Description
primaryKey	string	Clé primaire pour accéder aux API REST Cartes.
primaryKeyLastUpdated	string	Date et heure de la dernière mise à jour de la clé primaire.
secondaryKey	string	Clé secondaire pour accéder aux API REST Cartes.
secondaryKeyLastUpdated	string	Date et heure de la dernière mise à jour de la clé secondaire.

MapsKeySpecification

Object

Indique si l’opération fait référence à la clé primaire ou secondaire.

Nom	Type	Description
keyType	KeyType	Indique si l’opération fait référence à la clé primaire ou secondaire.