Accounts - Regenerate Keys

Layanan:

Maps Management

Versi API:

2023-06-01

Regenerasi kunci primer atau sekunder untuk digunakan dengan API Maps. Kunci lama akan segera berhenti bekerja.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama Akun Maps.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
keyType	True	KeyType	Apakah operasi mengacu pada kunci primer atau sekunder.

Respons

Nama	Jenis	Deskripsi
200 OK	MapsAccountKeys	Permintaan berhasil.
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Regenerate Key

Permintaan sampel

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
KeyType	Apakah operasi mengacu pada kunci primer atau sekunder.
MapsAccountKeys	Sekumpulan kunci yang dapat digunakan untuk mengakses API MAPS REST. Dua kunci disediakan untuk rotasi kunci tanpa gangguan.
MapsKeySpecification	Apakah operasi mengacu pada kunci primer atau sekunder.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

KeyType

Enumeration

Apakah operasi mengacu pada kunci primer atau sekunder.

Nilai	Deskripsi
primary
secondary

MapsAccountKeys

Objek

Sekumpulan kunci yang dapat digunakan untuk mengakses API MAPS REST. Dua kunci disediakan untuk rotasi kunci tanpa gangguan.

Nama	Jenis	Deskripsi
primaryKey	string	Kunci utama untuk mengakses API MAPS REST.
primaryKeyLastUpdated	string	Tanggal dan waktu terakhir yang diperbarui dari kunci primer.
secondaryKey	string	Kunci sekunder untuk mengakses API MAPS REST.
secondaryKeyLastUpdated	string	Tanggal dan waktu terakhir yang diperbarui dari kunci sekunder.

MapsKeySpecification

Objek

Apakah operasi mengacu pada kunci primer atau sekunder.

Nama	Jenis	Deskripsi
keyType	KeyType	Apakah operasi mengacu pada kunci primer atau sekunder.