Data Registry - Get Data Registry

Başvuru

Service:: Maps

API Version:: 2023-06-01

Belirtilen veri kayıt defteri bilgilerini almak için kullanın.

Get Data Registry API, başarılı olduğunda yanıtın gövdesinde JSON biçiminde bir AzureBlob nesnesi olarak veri kayıt defteri bilgilerini ve 200 HTTP durum kodunu döndüren bir HTTP isteğidirGET. Azure Haritalar temel alınan içeriğe erişemezse veya bütünlük denetimi başarısız olursa , status olarak ayarlanır Failed ve bir hata döndürülü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.

Veri Alma Kayıt Defteri İsteği Gönderme

Veri kayıt defteri GET isteği, belirtilen udidtarafından belirlenen istenen veri kayıt defterinin ayrıntılarını döndürür. Ayrıntılar yanıtın gövdesinde JSON biçiminde döndürülür.

GET 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. Regex pattern: `^[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.

Regex pattern: ^[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		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'de Microsoft Entra ID güvenliği kullanmak için rehberlik için aşağıdaki makalelere bakın.

Yanıtlar

Name Tür Description

200 OK

Name	Tür	Description
200 OK	DataRegistry	İstek `Get Data Registry` başarıyla tamamlandı. Yanıt gövdesi, belirtilen `udid`öğesinin veri kayıt defterini içerir.
Other Status Codes	MapsErrorResponse	Beklenmeyen bir hata oluştu. Headers x-ms-error-code: string

DataRegistry

İstek Get Data Registry başarıyla tamamlandı. Yanıt gövdesi, belirtilen udidöğesinin veri kayıt defterini içerir.

Other Status Codes

MapsErrorResponse

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ğa erişim tanımlamak 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ğı 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 yönetim düzleminden Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla 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 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.

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

Type: apiKey
In: header

Örnekler

Get the data registry of a completed udid

Get the data registry of a failed udid

Get the data registry of a completed udid

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "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,
    "contentMD5": "sOJMJvFParkSxBsvvrPOMQ=="
  },
  "status": "Completed"
}

Get the data registry of a failed udid

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "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"
  },
  "status": "Failed",
  "error": {
    "code": "AuthorizationPermissionMismatch",
    "message": "Not authorized to perform this operation on resource: https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json."
  }
}

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.

Share via

Data Registry - Get Data Registry

Veri Alma Kayıt Defteri İsteği Gönderme

URI Parametreleri

İstek Başlığı

Yanıtlar

Güvenlik

AADToken

Notlar

Scopes

subscription-key

SAS Token

Örnekler

Get the data registry of a completed udid

Sample Request

Sample Response

Get the data registry of a failed udid

Sample Request

Sample Response

Tanımlar

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Ek kaynaklar