Alias - List
Gunakan untuk mendapatkan daftar alias.
List
API adalah permintaan HTTP GET
yang memungkinkan penelepon untuk mengambil daftar semua alias yang ada.
Kirim Permintaan Daftar
Untuk mencantumkan semua alias, Anda akan mengeluarkan GET
permintaan tanpa parameter tambahan.
Respons Data Daftar
LIST API mengembalikan daftar lengkap semua alias dalam json
format. Respons berisi detail berikut untuk setiap sumber daya alias:
createdTimestamp - Tanda waktu yang dibuat alias. Format yyyy-MM-ddTHH:mm:ss.sssZ aliasId - Id untuk alias. creatorDataItemId - Id untuk item data pembuat yang direferensikan alias ini (bisa null jika alias belum ditetapkan). lastUpdatedTimestamp - Terakhir kali alias ditetapkan ke sumber daya. Format yyyy-MM-ddTHH:mm:ss.sssZ
Respons sampel yang mengembalikan 2 sumber daya alias:
{
"aliases": [
{
"createdTimestamp": "2020-02-13T21:19:11.123Z",
"aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
"creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
"lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
},
{
"createdTimestamp": "2020-02-18T19:53:33.123Z",
"aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
"creatorDataItemId": null,
"lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z"
}
]
}
GET https://{geography}.atlas.microsoft.com/aliases?api-version=2.0
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
geography
|
path | True |
string |
Parameter ini menentukan lokasi sumber daya Azure Maps Creator. Nilai yang valid adalah kita dan Uni Eropa. |
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
x-ms-client-id |
string |
Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Permintaan alias daftar berhasil diselesaikan. Isi respons berisi daftar semua alias yang dibuat sebelumnya. |
|
Other Status Codes |
Terjadi kesalahan tak terduga. |
Keamanan
AADToken
Ini adalah Alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa Azure Maps akun sumber daya atau sub-sumber daya. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.
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 diminta 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 direktori Azure Active.
* Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
* Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.
- Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.
Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.
Type:
apiKey
In:
query
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 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.
Type:
apiKey
In:
header
Contoh
List all the previously created aliases
Sample Request
GET https://us.atlas.microsoft.com/aliases?api-version=2.0
Sample Response
{
"aliases": [
{
"createdTimestamp": "2020-02-13T21:19:11+00:00",
"aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
"creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
"lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00"
},
{
"createdTimestamp": "2020-02-13T21:19:11+00:00",
"aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
"creatorDataItemId": null,
"lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00"
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Alias |
Informasi terperinci untuk alias. |
Alias |
Model respons untuk API Daftar. Mengembalikan daftar semua alias yang dibuat sebelumnya. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Alias
Informasi terperinci untuk alias.
Nama | Jenis | Deskripsi |
---|---|---|
aliasId |
string |
Id untuk alias. |
createdTimestamp |
string |
Tanda waktu yang dibuat untuk alias. |
creatorDataItemId |
string |
Id untuk item data pembuat yang direferensikan alias ini (bisa null jika alias belum ditetapkan). |
lastUpdatedTimestamp |
string |
Tanda waktu terakhir kali alias ditetapkan. |
AliasListResult
Model respons untuk API Daftar. Mengembalikan daftar semua alias yang dibuat sebelumnya.
Nama | Jenis | Deskripsi |
---|---|---|
aliases |
Alias[] |
Daftar semua alias yang dibuat sebelumnya. |
nextLink |
string |
Jika ada, lokasi halaman data berikutnya. |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorDetail
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |