Data Registry - Register Or Replace

Başvuru

Hizmet:: Maps

API Sürümü:: 2023-06-01

Azure Depolama Hesabında depolanan verileri bir Azure Haritalar hesabına kaydetmek için kullanın.

Register API, verileri bir Azure Depolama Hesabına Azure Haritalar hesabına 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'nde kullanılmak üzere biçiminde kaydetme veya Azure Haritalar Oluşturucu Dönüştürme Hizmeti'ndeGeoJSON kullanılmak üzere bir DWG tasarım dosyası kümesini sıkıştırılmış Çizim Paketi olarak kaydetme gibi senaryolarda kullanışlıdır.

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.

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

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. Normal ifade deseni: `^[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	Azure Haritalar API'sinin sürüm numarası.

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.

Normal ifade deseni: ^[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

Azure Haritalar API'sinin sürüm numarası.

İstek Başlığı

Name Gerekli Tür Description

x-ms-client-id

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.
Operation-Id		string	İŞLEM kimliği, GUID biçimindedir. Normal ifade deseni: `^[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

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.

Operation-Id

string

İŞLEM kimliği, GUID biçimindedir.

Normal ifade deseni: ^[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}$

İstek Gövdesi

Name	Tür	Description
azureBlob	AzureBlob	Azure blob veri kayıt defteri ayrıntıları.
description	string	Veri kayıt defterine verilen açıklama. Maksimum uzunluk 1024 karakterdir.
kind	DataRegistryKind	Veri kayıt defteri türü.

Yanıtlar

Name	Tür	Description
200 OK	DataRegistry	Kaynak değiştirme: İstek işlenmek üzere kabul edildi. Üst Bilgiler Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Kaynak oluşturma: İstek işlenmek üzere kabul edildi. Üst Bilgiler Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Beklenmeyen bir hata oluştu. Üst Bilgiler x-ms-error-code: string

Name

Tür

Description

200 OK

DataRegistry

Kaynak değiştirme: İstek işlenmek üzere kabul edildi.

Üst Bilgiler

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

Kaynak oluşturma: İstek işlenmek üzere kabul edildi.

Üst Bilgiler

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

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-idgerektirir. 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

Register or replace a udid

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
}

Durum kodu:: 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"
}

Tanımlar

Name	Description
AzureBlob	Azure blob veri kayıt defteri ayrıntıları.
DataFormat	Doğrulama amacıyla kullanılan karşıya yüklenen içeriğin veri biçimi.
DataRegistry	Azure Haritalar'daki veri kayıt defteri.
DataRegistryKind	Veri kayıt defteri türü.
LongRunningOperationStatus	Uzun süre çalışan bir işlemin durumu.
MapsErrorDetail	Hata ayrıntısı.
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ı.
MapsInnerError	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	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	AzureBlob	Azure blob veri kayıt defteri ayrıntıları.
description	string	Veri kayıt defterine verilen açıklama. Maksimum uzunluk 1024 karakterdir.
error	MapsErrorDetail	Hata ayrıntısı.
kind	DataRegistryKind	Veri kayıt defteri türü.
status	LongRunningOperationStatus	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

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	MapsErrorDetail[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	MapsInnerError	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	MapsErrorDetail	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	MapsInnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

Aracılığıyla paylaş

Data Registry - Register Or Replace

Yazmaç veya Değiştirme İsteği Gönder

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

AADToken

Notlar

Kapsamlar

subscription-key

SAS Token

Örnekler

Register or replace a udid

Örnek isteği

Örnek yanıt

Tanımlar

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Ek kaynaklar