Data Registry - List
Azure Haritalar hesabındaki tüm veri kayıt defterlerinin listesini almak için kullanın.
List
API, daha önce Yazma veya Değiştirme API'sini kullanarak kaydedilmiş tüm veri kayıt defterlerini içeren bir dizi döndüren bir HTTP GET
isteğidir.
Veri kayıt defteri hizmet uç noktasının kapsamı Azure Haritalar hesabınızın bölgesiyle sınırlıdır ve genel Azure Haritalar hesaplarında kullanılamaz.
Liste İsteği Gönder
Tüm veri kayıt defterlerinizi listelemek için ek parametre içermeyen bir GET
istek oluşturun.
Liste Yanıtı
İstek, List
yanıtın gövdesinde JSON
biçiminde bir veri kayıt defterleri dizisi döndürür.
GET https://{geography}.atlas.microsoft.com/dataRegistries?api-version=2023-06-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Bu parametre, Azure Haritalar Hesabının nerede bulunduğunu belirtir. Geçerli değerler: abd (Doğu ABD, Orta Batı ABD, Batı ABD 2) ve AB (Kuzey Avrupa, Batı Avrupa). |
api-version
|
query | True |
string |
Azure Haritalar API'sinin sürüm numarası. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID güvenlik modeliyle birlikte hangi hesabın kullanıma yönelik olduğunu belirtir. Azure Haritalar hesabı için benzersiz bir kimliği temsil eder ve Azure Haritalar yönetim düzlemi Hesap API'sinden alınabilir. Azure Haritalar'da Microsoft Entra ID güvenliğini kullanmak için rehberlik için aşağıdaki makalelere bakın. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
İstek |
|
Other Status Codes |
Beklenmeyen bir hata oluştu. Üst Bilgiler x-ms-error-code: string |
Güvenlik
AADToken
Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimi ile eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağına erişim belirtmek için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.
Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemek için bir çözüm sağlar.
Notlar
- Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağını belirtmek için üst bilgi kullanımını
x-ms-client-id
gerektirir. Bu, Haritalar yönetim API'sinden alınabilir.
Authorization URL
, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Microsoft Entra ID yapılandırmaları vardır.
* Azure rol tabanlı erişim denetimi Azure portalı, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzleminden yapılandırılır.
* Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.
- Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformuna genel bakış.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Bu, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağı oluştururken sağlanan paylaşılan bir anahtardır.
Bu anahtarla, tüm uygulamalar tüm REST API'lerine erişim yetkisine sahip olur. Başka bir deyişle, bunlar şu anda verildikleri hesabın ana anahtarları olarak değerlendirilebilir.
Herkese açık uygulamalar için önerimiz, bu anahtarın güvenli bir şekilde depolanabileceği Azure Haritalar REST API'lerinin sunucudan sunucuya erişiminin kullanılmasıdır.
Tür:
apiKey
İçinde:
header
SAS Token
Bu paylaşılan erişim imzası belirteci, Azure portalı, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağındaki Sas Listeleme işleminden oluşturulur.
Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirteç için kullanım süre sonu, oran ve bölgeler için ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların paylaşılan anahtardan daha güvenli bir şekilde erişimi denetlemesine izin vermek için kullanılabilir.
Herkese açık uygulamalar için önerimiz, işleme kötüye kullanımını sınırlamak ve SAS Belirtecini düzenli olarak yenilemek için Harita hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmayı önermektedir.
Tür:
apiKey
İçinde:
header
Örnekler
List all previously registered data registries
Örnek isteği
GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01
Örnek yanıt
{
"value": [
{
"udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"description": "Contoso Indoor Design",
"kind": "AzureBlob",
"azureBlob": {
"dataFormat": "zip",
"msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
"linkedResource": "my-storage-account",
"blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
"sizeInBytes": 29920,
"contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
},
"status": "Completed"
},
{
"udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"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/path2.geojson",
"sizeInBytes": 1339
},
"status": "Running"
},
{
"udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
"description": "Contoso Geofence GeoJSON",
"kind": "AzureBlob",
"azureBlob": {
"dataFormat": "geojson",
"linkedResource": "my-storage-account",
"blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
"sizeInBytes": 1650,
"contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
},
"status": "Failed",
"error": {
"code": "ContentMD5Mismatch",
"message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
}
}
]
}
Tanımlar
Name | Description |
---|---|
Azure |
Azure blob veri kayıt defteri ayrıntıları. |
Data |
Doğrulama amacıyla kullanılan karşıya yüklenen içeriğin veri biçimi. |
Data |
Azure Haritalar'daki veri kayıt defteri. |
Data |
Veri kayıt defteri türü. |
Data |
Veri kayıt defteri Listesi API'sinin yanıt modeli. Daha önce kaydedilmiş tüm verilerin listesini döndürür. |
Long |
Uzun süre çalışan bir işlemin durumu. |
Maps |
Hata ayrıntısı. |
Maps |
Başarısız işlemlerin hata ayrıntılarını döndürmek için Azure Haritalar API'leri için yaygın hata yanıtı. |
Maps |
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne. |
AzureBlob
Azure blob veri kayıt defteri ayrıntıları.
Name | Tür | Description |
---|---|---|
blobUrl |
string |
Blob URL'si, kaydedilmekte olan dosyanın yolunu içerir. |
contentMD5 |
string |
Veri doğrulama için kullanılan içeriğin MD5 içeriği. |
dataFormat |
Doğrulama amacıyla kullanılan karşıya yüklenen içeriğin veri biçimi. |
|
linkedResource |
string |
Azure Haritalar hesabındaki veri deposunun kimliği. |
msiClientId |
string |
Kullanıcı tarafından atanan yönetilen kimliğin istemci kimliği. Sağlanmadıysa sistem tarafından atanan yönetilen kimliği kullanın. |
sizeInBytes |
integer |
İçeriğin bayt cinsinden boyutu. |
DataFormat
Doğrulama amacıyla kullanılan karşıya yüklenen içeriğin veri biçimi.
Name | Tür | Description |
---|---|---|
geojson |
string |
GeoJSON , JSON tabanlı bir jeo-uzamsal veri değişim biçimidir. |
zip |
string |
Sıkıştırılmış veri biçimi. |
DataRegistry
Azure Haritalar'daki veri kayıt defteri.
Name | Tür | Description |
---|---|---|
azureBlob |
Azure blob veri kayıt defteri ayrıntıları. |
|
description |
string |
Veri kayıt defterine verilen açıklama. Maksimum uzunluk 1024 karakterdir. |
error |
Hata ayrıntısı. |
|
kind |
Veri kayıt defteri türü. |
|
status |
Uzun süre çalışan bir işlemin durumu. |
|
udid |
string |
Veri kayıt defterinin kullanıcı veri kimliği. |
DataRegistryKind
Veri kayıt defteri türü.
Name | Tür | Description |
---|---|---|
AzureBlob |
string |
Azure Blob |
DataRegistryList
Veri kayıt defteri Listesi API'sinin yanıt modeli. Daha önce kaydedilmiş tüm verilerin listesini döndürür.
Name | Tür | Description |
---|---|---|
nextLink |
string |
Sonraki veri kayıt defterleri kümesini almak için URL. |
value |
Veri kayıt defterleri dizisi. |
LongRunningOperationStatus
Uzun süre çalışan bir işlemin durumu.
Name | Tür | Description |
---|---|---|
Completed |
string |
İstek başarıyla tamamlandı. |
Failed |
string |
İstekte bir veya daha fazla hata var. |
Running |
string |
İstek şu anda işleniyor. |
MapsErrorDetail
Hata ayrıntısı.
Name | Tür | Description |
---|---|---|
code |
string |
Sunucu tanımlı hata kodları kümesinden biri. |
details |
Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi. |
|
innererror |
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne. |
|
message |
string |
Hatanın insan tarafından okunabilen bir gösterimi. |
target |
string |
Hatanın hedefi. |
MapsErrorResponse
Başarısız işlemlerin hata ayrıntılarını döndürmek için Azure Haritalar API'leri için yaygın hata yanıtı.
Name | Tür | Description |
---|---|---|
error |
Hata ayrıntısı. |
MapsInnerError
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
Name | Tür | Description |
---|---|---|
code |
string |
Hata kodu. |
innererror |
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne. |