Data Registry - Register Or Replace
Azure Depolama Hesabında depolanan verileri bir Azure Haritalar hesabına kaydetmek için kullanın.
Register
API, verileri azure depolama hesabına Azure Haritalar bir hesaba kaydetmek için kullanılan bir HTTP PUT
isteğidir. Kaydedilebilecek en büyük dosya boyutu bir gigabayttır.
Bu, geofences koleksiyonunu Azure Haritalar Coğrafi Sınırlama Hizmeti'ndeGeoJSON
kullanılmak üzere biçimde kaydetme veya DWG tasarım dosyalarının bir kümesini Azure Haritalar Creator Dönüştürme Hizmeti'nde kullanılmak üzere sıkıştırılmış Çizim Paketi olarak kaydetme gibi senaryolarda kullanışlıdır.
Veri kayıt defteri hizmet uç noktası, kapsamı Azure Haritalar hesabınızın bölgesiyle sınırlıdır ve genel Azure Haritalar hesaplarında kullanılamaz.
Yazmaç veya Değiştirme İsteği Gönder
Register
ve Replace
istekleri, veri kayıt defteri ayrıntılarını tanımlayan isteğin gövdesinde Bir AzureBlob JSON nesnesi içeren uzun süre çalışan işlemlerdir.
PUT https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?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). |
udid
|
path | True |
string |
Veri kayıt defterinin kullanıcı veri kimliği. Regex pattern: |
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 |
Hangi hesabın Microsoft Entra ID güvenlik modeliyle birlikte 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 Microsoft Entra ID güvenliğini kullanmak için kılavuz için aşağıdaki makalelere bakın. |
|
Operation-Id |
string |
İŞLEM kimliği, GUID biçimindedir. Regex pattern: |
İstek Gövdesi
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. |
kind |
Veri kayıt defteri türü. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Kaynak değiştirme: İstek işlenmek üzere kabul edildi. Headers
|
|
201 Created |
Kaynak oluşturma: İstek işlenmek üzere kabul edildi. Headers
|
|
Other Status Codes |
Beklenmeyen bir hata oluştu. Headers x-ms-error-code: string |
Güvenlik
AADToken
Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimiyle 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şimi tanımlamak için kullanılır. Herhangi bir kullanıcı, grup veya hizmet sorumlusuna yerleşik bir rol veya REST API'lerini Azure Haritalar 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ı modellemeye yönelik bir çözüm sağlar.
Notlar
- Bu güvenlik tanımı, uygulamanın erişim isteğinde
x-ms-client-id
bulunduğu Azure Haritalar kaynağı belirtmek için üst bilginin kullanılmasını gerektirir. Bu, Haritalar yönetim API'sinden edinilebilir.
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 platformu genel bakış.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
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 kabul edilebilir.
Genel kullanıma sunulan uygulamalar için önerimiz, bu anahtarın güvenli bir şekilde depolanabildiği Azure Haritalar REST API'lerinin sunucudan sunucuya erişiminin kullanılmasıdır.
Type:
apiKey
In:
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 belirtecin kullanım süresi, oranı ve bölgelerine yönelik ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların erişimi paylaşılan anahtardan daha güvenli bir şekilde denetlemesine izin vermek için kullanılabilir.
Herkese açık uygulamalar için önerimiz, uygunsuz işlemeyi 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ırmanızdır.
Type:
apiKey
In:
header
Örnekler
Register or replace a udid
Sample Request
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"
}
}
Sample Response
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"
}
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"
}
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ü. |
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 genel hata yanıtı. |
Maps |
Hatayla ilgili geçerli nesneden daha belirli 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ğrulaması 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 defteri için kullanıcı veri kimliği. |
DataRegistryKind
Veri kayıt defteri türü.
Name | Tür | Description |
---|---|---|
AzureBlob |
string |
Azure Blob |
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 bir dizi ayrıntı. |
|
innererror |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |
|
message |
string |
Hatanın insanlar tarafından okunabilir 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 genel hata yanıtı.
Name | Tür | Description |
---|---|---|
error |
Hata ayrıntısı. |
MapsInnerError
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
Name | Tür | Description |
---|---|---|
code |
string |
Hata kodu. |
innererror |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |