Accounts - Regenerate Keys

Dienst:

Maps Management

API-Version:

2023-06-01

Generieren Sie entweder den primären oder sekundären Schlüssel für die Verwendung mit den Karten-APIs. Die alte Taste funktioniert nicht mehr sofort.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Kartenkontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
keyType	True	KeyType	Gibt an, ob sich der Vorgang auf den primären oder sekundären Schlüssel bezieht.

Antworten

Name	Typ	Beschreibung
200 OK	MapsAccountKeys	Die Anfrage war erfolgreich.
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Regenerate Key

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
KeyType	Gibt an, ob sich der Vorgang auf den primären oder sekundären Schlüssel bezieht.
MapsAccountKeys	Der Satz von Schlüsseln, die für den Zugriff auf die Karten-REST-APIs verwendet werden können. Zwei Schlüssel werden für die Schlüsseldrehung ohne Unterbrechung bereitgestellt.
MapsKeySpecification	Gibt an, ob sich der Vorgang auf den primären oder sekundären Schlüssel bezieht.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

KeyType

Enumeration

Gibt an, ob sich der Vorgang auf den primären oder sekundären Schlüssel bezieht.

Wert	Beschreibung
primary
secondary

MapsAccountKeys

Objekt

Der Satz von Schlüsseln, die für den Zugriff auf die Karten-REST-APIs verwendet werden können. Zwei Schlüssel werden für die Schlüsseldrehung ohne Unterbrechung bereitgestellt.

Name	Typ	Beschreibung
primaryKey	string	Der Primärschlüssel für den Zugriff auf die Karten-REST-APIs.
primaryKeyLastUpdated	string	Das datum und die Uhrzeit der letzten Aktualisierung des Primärschlüssels.
secondaryKey	string	Der sekundäre Schlüssel für den Zugriff auf die Karten-REST-APIs.
secondaryKeyLastUpdated	string	Das datum und die Uhrzeit der letzten Aktualisierung des Sekundärschlüssels.

MapsKeySpecification

Objekt

Gibt an, ob sich der Vorgang auf den primären oder sekundären Schlüssel bezieht.

Name	Typ	Beschreibung
keyType	KeyType	Gibt an, ob sich der Vorgang auf den primären oder sekundären Schlüssel bezieht.