Data Registry - List

Başvuru

Service:: Maps

API Version:: 2023-06-01

Azure Haritalar hesabındaki tüm veri kayıt defterlerinin listesini almak için kullanın.

List API, daha önce Kaydet veya Değiştir 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ı, 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.

Yanıtı Listele

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

Yanıtlar

Name Tür Description

200 OK

Name	Tür	Description
200 OK	DataRegistryList	İstek `List` başarıyla tamamlandı. Yanıt gövdesi bir veri kayıt defterleri dizisi içerir.
Other Status Codes	MapsErrorResponse	Beklenmeyen bir hata oluştu. Headers x-ms-error-code: string

DataRegistryList

İstek List başarıyla tamamlandı. Yanıt gövdesi bir veri kayıt defterleri dizisi 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ğı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

List all previously registered data registries

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "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
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ü.
DataRegistryList	Veri kayıt defteri Liste API'sinin yanıt modeli. Daha önce kaydedilmiş tüm verilerin listesini döndürü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 genel hata yanıtı.
MapsInnerError	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	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 defteri için kullanıcı veri kimliği.

DataRegistryKind

Veri kayıt defteri türü.

Name	Tür	Description
AzureBlob	string	Azure Blob