Data Registry - Register Or Replace

Referensi

Layanan:: Maps

Versi API:: 2023-06-01

Gunakan untuk mendaftarkan data yang disimpan di Akun Azure Storage dengan akun Azure Maps.

Register API adalah permintaan HTTP PUT yang digunakan untuk mendaftarkan data di Akun Azure Storage dengan akun Azure Maps. Ukuran file maksimum yang dapat didaftarkan adalah satu gigabyte.

Ini berguna dalam skenario seperti mendaftarkan kumpulan Geofences dalam GeoJSON format untuk digunakan di Azure Maps Geofencing Service, atau mendaftarkan sekumpulan file desain DWG sebagai Paket Gambar zip untuk digunakan dalam Layanan Konversi Pembuat Azure Maps.

Titik akhir layanan registri data dibatasi dalam cakupan ke wilayah akun Azure Maps Anda dan tidak tersedia untuk akun Azure Maps global.

Kirim Daftar atau Ganti Permintaan

Permintaan Register dan Replace keduanya adalah operasi jangka panjang yang berisi objek AzureBlob JSON dalam isi permintaan yang menentukan detail registri data.

PUT https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi

Nama	Dalam	Diperlukan	Jenis	Deskripsi
geography	path	True	string	Parameter ini menentukan tempat Akun Azure Maps berada. Nilai yang valid adalah kita (US Timur, US Tengah Barat, AS Barat 2) dan Eropa (Eropa Utara, Eropa Barat).
udid	path	True	string	ID data pengguna dari registri data. Pola regex: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
api-version	query	True	string	Nomor versi Azure Maps API.

geography

path

True

string

Parameter ini menentukan tempat Akun Azure Maps berada. Nilai yang valid adalah kita (US Timur, US Tengah Barat, AS Barat 2) dan Eropa (Eropa Utara, Eropa Barat).

udid

path

True

string

ID data pengguna dari registri data.

Pola regex: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

api-version

query

True

string

Nomor versi Azure Maps API.

Header Permintaan

Nama Diperlukan Jenis Deskripsi

x-ms-client-id

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan ID Microsoft Entra. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan.
Operation-Id		string	ID operasi, dalam format GUID. Pola regex: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`

string

Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan ID Microsoft Entra. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan.

Operation-Id

string

ID operasi, dalam format GUID.

Pola regex: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

Isi Permintaan

Nama	Jenis	Deskripsi
azureBlob	AzureBlob	Detail registri data blob Azure.
description	string	Deskripsi yang diberikan ke registri data. Panjang maksimum adalah 1024 karakter.
kind	DataRegistryKind	Jenis registri data.

Respons

Nama	Jenis	Deskripsi
200 OK	DataRegistry	Penggantian sumber daya: Permintaan telah diterima untuk diproses. Header Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Pembuatan sumber daya: Permintaan telah diterima untuk diproses. Header Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Terjadi kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

DataRegistry

Penggantian sumber daya: Permintaan telah diterima untuk diproses.

Header

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

Pembuatan sumber daya: Permintaan telah diterima untuk diproses.

Header

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

Terjadi kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

AADToken

Ini adalah Alur Microsoft Entra OAuth 2.0 . Saat dipasangkan dengan kontrol akses berbasis peran Azure , kontrol akses tersebut dapat digunakan untuk mengontrol akses ke REST API Azure Maps. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin ke REST API Azure Maps.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi ID Microsoft Entra. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan aplikasi berbasis konfigurasi untuk beberapa kasus penggunaan.

Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat Gambaran umum platform identitas Microsoft.

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

Cakupan

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun berwenang untuk mengakses semua REST API. Dengan kata lain, ini saat ini dapat diperlakukan sebagai kunci master ke akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server dari REST API Azure Maps tempat kunci ini dapat disimpan dengan aman.

Jenis: apiKey
Dalam: header

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

Register or replace a udid

Permintaan sampel

HTTP

PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01

{
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json"
  }
}

Respon sampel

Kode status:: 201

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

Kode status:: 200

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

Definisi

Nama	Deskripsi
AzureBlob	Detail registri data blob Azure.
DataFormat	Format data konten yang diunggah yang digunakan untuk tujuan validasi.
DataRegistry	Registri data di Azure Maps.
DataRegistryKind	Jenis registri data.
LongRunningOperationStatus	Status operasi yang berjalan lama.
MapsErrorDetail	Detail kesalahan.
MapsErrorResponse	Respons kesalahan umum untuk API Azure Maps untuk mengembalikan detail kesalahan untuk operasi yang gagal.
MapsInnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

AzureBlob

Detail registri data blob Azure.

Nama	Jenis	Deskripsi
blobUrl	string	URL blob berisi jalur ke file yang sedang didaftarkan.
contentMD5	string	Konten MD5 dari konten, digunakan untuk validasi data.
dataFormat	DataFormat	Format data konten yang diunggah yang digunakan untuk tujuan validasi.
linkedResource	string	ID datastore di akun Azure Maps.
msiClientId	string	ID klien identitas terkelola yang ditetapkan pengguna. Gunakan identitas terkelola yang ditetapkan sistem jika tidak disediakan.
sizeInBytes	integer	Ukuran konten dalam byte.

DataFormat

Format data konten yang diunggah yang digunakan untuk tujuan validasi.

Nama	Jenis	Deskripsi
geojson	string	GeoJSON adalah format pertukaran data geospasial berbasis JSON.
zip	string	Format data terkompresi.

DataRegistry

Registri data di Azure Maps.

Nama	Jenis	Deskripsi
azureBlob	AzureBlob	Detail registri data blob Azure.
description	string	Deskripsi yang diberikan ke registri data. Panjang maksimum adalah 1024 karakter.
error	MapsErrorDetail	Detail kesalahan.
kind	DataRegistryKind	Jenis registri data.
status	LongRunningOperationStatus	Status operasi yang berjalan lama.
udid	string	ID data pengguna untuk registri data.

DataRegistryKind

Jenis registri data.

Nama	Jenis	Deskripsi
AzureBlob	string	Azure Blob

LongRunningOperationStatus

Status operasi yang berjalan lama.

Nama	Jenis	Deskripsi
Completed	string	Permintaan berhasil diselesaikan.
Failed	string	Permintaan memiliki satu atau beberapa kegagalan.
Running	string	Permintaan saat ini sedang diproses.

MapsErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
details	MapsErrorDetail[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	MapsInnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

MapsErrorResponse

Respons kesalahan umum untuk API Azure Maps untuk mengembalikan detail kesalahan untuk operasi yang gagal.

Nama	Jenis	Deskripsi
error	MapsErrorDetail	Detail kesalahan.

MapsInnerError

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
innererror	MapsInnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

Bagikan melalui

Data Registry - Register Or Replace

Kirim Daftar atau Ganti Permintaan

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

AADToken

Catatan

Cakupan

subscription-key

SAS Token

Contoh

Register or replace a udid

Permintaan sampel

Respon sampel

Definisi

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Sumber Daya Tambahan: