Accounts - Regenerate Keys

Tjänst:

Maps Management

API-version:

2023-06-01

Återskapa antingen den primära eller sekundära nyckeln för användning med Maps-API:erna. Den gamla nyckeln slutar fungera omedelbart.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Namnet på Maps-kontot.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
keyType	True	KeyType	Om åtgärden refererar till den primära eller sekundära nyckeln.

Svar

Name	Typ	Description
200 OK	MapsAccountKeys	Begäran lyckades.
Other Status Codes	ErrorResponse	Ett oväntat fel uppstod.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Regenerate Key

Exempelbegäran

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
KeyType	Om åtgärden refererar till den primära eller sekundära nyckeln.
MapsAccountKeys	Den uppsättning nycklar som kan användas för att komma åt MAPS REST-API:er. Två nycklar tillhandahålls för nyckelrotation utan avbrott.
MapsKeySpecification	Om åtgärden refererar till den primära eller sekundära nyckeln.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

KeyType

Uppräkning

Om åtgärden refererar till den primära eller sekundära nyckeln.

Värde	Description
primary
secondary

MapsAccountKeys

Objekt

Den uppsättning nycklar som kan användas för att komma åt MAPS REST-API:er. Två nycklar tillhandahålls för nyckelrotation utan avbrott.

Name	Typ	Description
primaryKey	string	Den primära nyckeln för åtkomst till Maps REST API:er.
primaryKeyLastUpdated	string	Datum och tid för den primära nyckeln som uppdaterades senast.
secondaryKey	string	Den sekundära nyckeln för åtkomst till Maps REST API:er.
secondaryKeyLastUpdated	string	Datum och tid för den sekundära nyckeln som uppdaterades senast.

MapsKeySpecification

Objekt

Om åtgärden refererar till den primära eller sekundära nyckeln.

Name	Typ	Description
keyType	KeyType	Om åtgärden refererar till den primära eller sekundära nyckeln.