Data - List

Başvuru

Service:: Maps

API Version:: 2.0

Daha önce Veri Yükleme kullanılarak karşıya yüklenen tüm içeriğin listesini getirmek için kullanın.

Not

Azure Haritalar Veri hizmetinin kullanımdan kaldırılması

Azure Haritalar Veri hizmeti (hem v1 hem de v2) artık kullanım dışıdır ve 16.09.24 tarihinde kullanımdan kaldırılacaktır. Hizmet kesintilerini önlemek için Veri hizmetine yapılan tüm çağrıların 16.09.24'e kadar Azure Haritalar Veri Kayıt Defteri hizmetini kullanacak şekilde güncelleştirilmesi gerekir. Daha fazla bilgi için bkz. Veri kayıt defteri oluşturma.

Data List API, çağıranın daha önce Veri Yükleme API'sini kullanarak karşıya yüklenen tüm içeriğin listesini getirmesine olanak tanıyan bir HTTP GET isteğidir.

Liste İsteği Gönder

Tüm harita verileri içeriğinizi listelemek için ek parametre içermeyen bir GET istekte bulunacaksınız.

Liste Veri Yanıtı

Veri Listesi API'si, biçimindeki tüm verilerin json tam listesini döndürür. Yanıt, her veri kaynağı için aşağıdaki ayrıntıları içerir:

udid - Veri kaynağının benzersiz veri kimliği.

location - Veri kaynağının konumu. Verileri indirmek için bu konumda bir HTTP GET isteği yürütebilirsiniz.

3 veri kaynağının udid ve location değerini döndüren örnek bir yanıt aşağıda verilmişti:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

GET https://{geography}.atlas.microsoft.com/mapData?api-version=2.0

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
geography	path	True	string	Bu parametre, Azure Haritalar Oluşturucu kaynağının nerede bulunduğunu belirtir. Geçerli değerler biz ve AB'lerdir.
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	MapDataListResult	Liste veri isteği başarıyla tamamlandı. Yanıt gövdesi, daha önce karşıya yüklenen tüm verilerin listesini içerir.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata oluştu.

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 bir Azure Haritalar hesabı İçerik Oluşturucu veya PowerShell, CLI, Azure SDK'ları veya REST API'sini kullandığınızda sağlanan paylaşılan bir anahtardır.

Bu anahtarla, tüm uygulamalar tüm REST API'lere erişebilir. Başka bir deyişle, bu anahtar, verildikleri hesapta ana anahtar olarak kullanılabilir.

Herkese açık uygulamalar için, anahtarınızın güvenli bir şekilde depolanabilmesi için gizli istemci uygulamaları yaklaşımını kullanarak Azure Haritalar REST API'lerine erişmenizi öneririz.

Type: apiKey
In: query

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

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?api-version=2.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://us.atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Tanımlar

Name	Description
DataFormat	Karşıya yüklenen içeriğin veri biçimi.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
MapData	Veriler için ayrıntılı bilgiler.
MapDataListResult	Veri Listesi API'sinin yanıt modeli. Daha önce karşıya yüklenen tüm verilerin listesini döndürür.
UploadStatus	İçeriğin geçerli karşıya yükleme durumu.

DataFormat

Karşıya yüklenen içeriğin veri biçimi.

Name	Tür	Description
dwgzippackage	string	DWG dosyasını içeren ZIP paketi.
geojson	string	GeoJSON , JSON tabanlı bir jeo-uzamsal veri değişim biçimidir.
zip	string	Sıkıştırılmış veri biçimi.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

MapData

Veriler için ayrıntılı bilgiler.

Name	Tür	Description
dataFormat	DataFormat	Karşıya yüklenen içeriğin veri biçimi.
description	string	Geçerli açıklama.
location	string	Verilerin konumu. Verileri indirmek için bu konumda bir HTTP `GET` isteği yürütebilirsiniz.
sizeInBytes	integer	İçeriğin bayt cinsinden boyutu.
udid	string	Verilerin benzersiz veri kimliği.
uploadStatus	UploadStatus	İçeriğin geçerli karşıya yükleme durumu.

MapDataListResult

Veri Listesi API'sinin yanıt modeli. Daha önce karşıya yüklenen tüm verilerin listesini döndürür.

Name	Tür	Description
mapDataList	MapData[]	Daha önce karşıya yüklenen tüm verilerin listesi.

UploadStatus

İçeriğin geçerli karşıya yükleme durumu.

Name	Tür	Description
Completed	string	Karşıya yükleme doğrulama ve işleme tamamlandı
Failed	string	Karşıya yükleme doğrulama ve/veya işleme hatası
Pending	string	Karşıya yükleme işleniyor