Dataset - Get

Reference

Service:: Maps Creator

API Version:: 2.0

Slouží k získání podrobností o datové sadě.

Odeslat žádost o získání podrobností

Pokud chcete získat podrobnosti o dříve vytvořené datové sadě, odešlete GET žádost s příkazem datasetId v cestě.

Získat odpověď na podrobnosti

Rozhraní API Get Details vrátí podrobnosti o datové sadě ve json formátu. Odpověď obsahuje následující pole (pokud nejsou null nebo prázdná):

created – časové razítko, které byla datová sada vytvořena. datasetId – ID datové sady. description – popis datové sady. datasetSources – zdrojová data, která se použila při vystavení žádosti o vytvoření. ontology – zdrojová ontologie použitá v konverzní službě pro vstupní data.

Popisuje datasetSources zdrojová data, která se použila při vystavení žádosti o vytvoření, a obsahuje následující prvky (pokud nejsou null nebo prázdné):

conversionIds – seznam conversionId hodnot (null, pokud nebyl zadaný žádný). appendDatasetId – hodnota datasetId , která byla použita pro operaci připojení (null, pokud nebyla použita žádná). featureCounts – počty pro každý typ funkce v datové sadě.

Tady je ukázková odpověď, která timestampdatasetIddescriptionvrací , , datasetSourcesa ontology prostředku datové sady:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
datasetId	path	True	string	Identifikátor datové sady, ze které se má dotazovat.
geography	path	True	string	Tento parametr určuje, kde se nachází prostředek Azure Maps Creator. Platné hodnoty jsou my a eu.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	Dataset	Žádost o získání datové sady se úspěšně dokončila.
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

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

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Type: apiKey
In: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
Dataset	Podrobné informace o datové sadě
DatasetSources	Informace o podrobnostech žádosti o vytvoření datové sady
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu

Dataset

Podrobné informace o datové sadě

Name	Typ	Description
created	string	Vytvořené časové razítko pro datovou sadu.
datasetId	string	ID datové sady.
datasetSources	DatasetSources	Informace o podrobnostech žádosti o vytvoření datové sady
description	string	Popis datové sady.
featureCounts	object	Funkce se počítá pro datovou sadu.
ontology	string	Verze ontologie této datové sady.

DatasetSources

Informace o podrobnostech žádosti o vytvoření datové sady

Name	Typ	Description
appendDatasetId	string	Datová sada připojená k vytvoření aktuální datové sady.
conversionIds	string[]	Seznam použitých `conversionId` k vytvoření datové sady.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Share via