Dataset - Get

A következőkre vonatkozik: lásd a tarifacsomagokat.

A létrehozó lehetővé teszi az alkalmazások fejlesztését a privát beltéri térképadatok alapján Azure Maps API és SDK használatával. Ez a cikk a Azure Maps Creatorra vonatkozó fogalmakat és eszközöket ismerteti.

Ez az API lehetővé teszi, hogy a hívó lekérjen egy korábban sikeresen létrehozott adatkészletet.

Részletek beolvasása kérelem elküldése

Ha egy korábban létrehozott adathalmaz adatait szeretné lekérni, egy kérést GET fog kiadni az datasetId elérési úton.

Részletek lekérése válasz

A Részletek lekérése API egy adathalmaz json adatait adja vissza formátumban. A válasz a következő mezőket tartalmazza (ha nem null értékűek vagy üresek):

created – Az adathalmaz létrehozásának időbélyege. datasetId – Az adathalmaz azonosítója. description – Az adathalmaz leírása. datasetSources – A létrehozási kérelem kiadásakor használt forrásadatok. ontológia – A bemeneti adatok konvertálási szolgáltatásában használt forrásontológia .

A datasetSources cikk ismerteti a létrehozási kérelem kiadásakor használt forrásadatokat, és az alábbi elemeket tartalmazza (ha nem null értékűek vagy üresek):

conversionIds – A lista conversionId (null, ha nincs megadva). appendDatasetId – A datasetId hozzáfűzési művelethez használt érték (null érték, ha nincs használva). featureCounts – Az adathalmaz egyes funkciótípusainak száma.

Íme egy mintaválasz, amely egy timestampadathalmaz-erőforrást ad ontologydatasetIddescriptiondatasetSourcesvissza:

{
   "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-paraméterek

Name In Required Type Description
datasetId
path True
  • string

Annak az adathalmaznak az azonosítója, amelyből lekérdezni szeretne.

geography
path True
  • string

Ez a paraméter határozza meg, hogy a Azure Maps Létrehozó erőforrás hol található. Érvényes értékek vagyunk és eu.

api-version
query True
  • string

A Azure Maps API verziószáma.

Kérelem fejléce

Name Required Type Description
x-ms-client-id
  • string

Meghatározza, hogy melyik fiók legyen a Azure AD biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, amely a Azure Maps felügyeleti sík fiók API-jából kérhető le. Ha Azure AD biztonságot szeretne használni Azure Maps tekintse meg az alábbi cikkeket.

Válaszok

Name Type Description
200 OK

Az adathalmaz-lekérési kérelem sikeresen befejeződött.

Other Status Codes

Váratlan hiba történt.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel, vagy egy vagy több REST API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást kínál az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

  • Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Maps felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Webes SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

  • Az Azure Active Directory 1.0-s vagy 2.0-s verziója jelenleg támogatja a Munkahelyi, iskolai és Vendég verziót, de nem támogatja a személyes fiókokat.

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

Ez egy megosztott kulcs, amelyet akkor épít ki a rendszer, ha Azure Maps-fiókot hoz létre a Azure Portal vagy a PowerShell, a parancssori felület, az Azure SDK-k vagy a REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetén azt javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével férhessen hozzá Azure Maps REST API-khoz, hogy a kulcs biztonságosan tárolható legyen.

Type: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps-erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, parancssori felület, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőivel és részletes vezérlésével az adott jogkivonat lejáratához, sebességéhez és régióihoz. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfigurálja az engedélyezett források meghatározott listáját a térképfiók-erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Type: apiKey
In: header

Példák

Get details for a previously created dataset

Sample Request

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

Sample Response

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location
{
  "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"
}

Definíciók

Dataset

Az adathalmaz részletes adatai.

DatasetSources

Információ az adathalmaz létrehozási kérésének részleteiről.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorDetail

A hiba részletei.

ErrorResponse

Hibaválasz

Dataset

Az adathalmaz részletes adatai.

Name Type Description
created
  • string

Az adathalmazhoz létrehozott időbélyeg.

datasetId
  • string

Az adathalmaz azonosítója.

datasetSources

Információ az adathalmaz létrehozási kérésének részleteiről.

description
  • string

Az adathalmaz leírása.

featureCounts
  • object

A funkció az adathalmazhoz számít.

ontology
  • string

Az adathalmaz ontológiai verziója.

DatasetSources

Információ az adathalmaz létrehozási kérésének részleteiről.

Name Type Description
appendDatasetId
  • string

Az aktuális adatkészlet létrehozásához hozzáfűzött adatkészlet.

conversionIds
  • string[]

Az adathalmaz létrehozásához használt lista conversionId .

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Type Description
info
  • object

A további információk.

type
  • string

A további információtípus.

ErrorDetail

A hiba részletei.

Name Type Description
additionalInfo

A hiba további információi.

code
  • string

A hibakód.

details

A hiba részletei.

message
  • string

A hibaüzenet.

target
  • string

A hiba célja.

ErrorResponse

Hibaválasz

Name Type Description
error

A hibaobjektum.