Dataset - Get

Başvuru

Service:: Maps Creator

API Version:: 2.0

Veri kümesinin ayrıntılarını almak için kullanın.

Ayrıntıları Alma İsteği Gönder

Önceden oluşturulmuş bir veri kümesinin ayrıntılarını almak için yolunda ile datasetId bir GET istek yayımlayabilirsiniz.

Ayrıntıları Alma Yanıtı

Ayrıntıları Al API'si, bir veri kümesinin json ayrıntılarını biçiminde döndürür. Yanıt aşağıdaki alanları içerir (null veya boş değilse):

created - Veri kümesinin oluşturulduğu zaman damgası. datasetId - Veri kümesinin kimliği. description - Veri kümesinin açıklaması. datasetSources - Oluşturma isteği yayımlandığında kullanılan kaynak veriler. ontology - Giriş verileri için dönüştürme hizmetinde kullanılan kaynak ontolojisi .

, datasetSources oluşturma isteği verildiğinde kullanılan kaynak verileri açıklar ve aşağıdaki öğeleri içerir (null veya boş değilse):

conversionIds - Listesi conversionId (hiçbiri sağlanmadıysa null). appendDatasetId - datasetId Ekleme işlemi için kullanılan (hiçbiri kullanılmadıysa null). featureCounts - Veri kümesindeki her özellik türünün sayısı.

Aşağıda, bir veri kümesi kaynağının timestamp, datasetId, description, datasetSourcesve ontology değerini döndüren örnek bir yanıt verilmişti:

{
   "timestamp": "2020-01-01T22:50:48.123Z",
   "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
   "description": "Some description or comment for the dataset.",
   "datasetSources": {
     "conversionIds": [
       "15d21452-c9bb-27b6-5e79-743ca5c3205d"
     ],
   },
   "ontology": "facility-2.0",
   "featureCounts": {
     "directoryInfo": 2,
     "category": 10,
     "facility": 1,
     "level": 3,
     "unit": 183,
     "zone": 3,
     "verticalPenetration": 6,
     "opening": 48,
     "areaElement": 108
   }
 }

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
datasetId	path	True	string	Sorguya alınacak veri kümesinin tanımlayıcısı.
geography	path	True	string	Bu parametre, Azure Haritalar Oluşturucu kaynağının nerede bulunduğunu belirtir. Geçerli değerler: biz ve AB.
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	Dataset	Veri kümesi alma isteği başarıyla tamamlandı.
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ğı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 Azure Haritalar hesabı oluşturduğunuzda veya PowerShell, CLI, Azure SDK'ları veya REST API 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 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

Get details for a previously created dataset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/datasets/[datasetId]?api-version=2.0

Sample Response

Status code:: 200

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location

Response Body

{
  "created": "2021-05-21T01:02:03.456Z",
  "datasetId": "[datasetId]",
  "description": "Some description or comment about the dataset",
  "datasetSources": {
    "conversionIds": [
      "15d21452-c9bb-27b6-5e79-743ca5c3205d",
      "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d"
    ],
    "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733"
  },
  "featureCounts": {
    "directoryInfo": 2,
    "category": 10,
    "facility": 1,
    "level": 3,
    "unit": 183,
    "zone": 3,
    "verticalPenetration": 6,
    "opening": 48,
    "areaElement": 108
  },
  "ontology": "facility-2.0"
}

Tanımlar

Name	Description
Dataset	Veri kümesi için ayrıntılı bilgiler.
DatasetSources	Veri kümesi için oluşturma isteğinin ayrıntıları hakkında bilgi.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı

Dataset

Veri kümesi için ayrıntılı bilgiler.

Name	Tür	Description
created	string	Veri kümesi için oluşturulan zaman damgası.
datasetId	string	Veri kümesinin kimliği.
datasetSources	DatasetSources	Veri kümesi için oluşturma isteğinin ayrıntıları hakkında bilgi.
description	string	Veri kümesinin açıklaması.
featureCounts	object	Özellik, veri kümesi için sayılır.
ontology	string	Bu veri kümesinin ontoloji sürümü.

DatasetSources

Veri kümesi için oluşturma isteğinin ayrıntıları hakkında bilgi.

Name	Tür	Description
appendDatasetId	string	Geçerli veri kümesini oluşturmak için sonuna eklenen veri kümesi.
conversionIds	string[]	Veri kümesini oluşturmak için kullanılan listenin listesi `conversionId` .

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.