Dataset - List
A használatával lekérheti az összes meglévő adathalmaz listáját.
Az összes adathalmaz listázásához további paraméterek nélkül fog kiadni egy GET
kérést.
Adatválasz listázása
A List API az összes adathalmaz json
teljes listáját 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
a létrehozási kérelem kiadásakor használt forrásadatokat ismerteti, és a következő elemeket tartalmazza (ha nem null értékűek vagy üresek):
conversionIds – A (null értékű, ha nincs megadva) listája
conversionId
. appendDatasetId – AdatasetId
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, ontology
datasetSources
description
datasetId
amely timestamp
3 adathalmaz-erőforrást ad vissza:
{
"datasets": [
{
"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"
], },
"": "facility-2.0",
"featureCounts": {
"directoryInfo": 2,
"category": 10,
"facility": 1,
"level": 3,
"unit": 183,
"zone": 3,
"verticalPenetration": 6,
"opening": 48,
"areaElement": 108
}
},
{
"timestamp": "2020-01-01T22:57:53.123Z",
"datasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"description": "Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.",
"datasetSources": {
"conversionIds": [
"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c"
],
"appendDatasetId": "46d1edb6-d29e-4786-9589-dbd4efd7a977"
},
"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?api-version=2.0
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Ez a paraméter határozza meg, hogy hol található a Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu. |
api-version
|
query | True |
string |
Azure Maps API verziószáma. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-id |
string |
Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Az adathalmaz-kérelem sikeresen befejeződött. A válasz törzse tartalmazza a korábban létrehozott adatkészletet. |
|
Other Status Codes |
Váratlan hiba történt. |
Biztonság
AADToken
Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. 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 nyújt 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 melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.
A Authorization URL
az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID 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 Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.
- A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy PowerShell, CLI, Azure SDK vagy 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 javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.
Típus:
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, CLI, 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őihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.
Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.
Típus:
apiKey
In:
header
Példák
List all the previously created datasets
Mintakérelem
GET https://us.atlas.microsoft.com/datasets?api-version=2.0
Mintaválasz
{
"datasets": [
{
"created": "2021-05-21T03:04:05.678Z",
"datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"description": "Some description or comment for the dataset.",
"datasetSources": {
"conversionIds": [
"db63843c-3c70-4b4e-94ff-dfcf4013c4a9"
]
},
"featureCounts": {
"directoryInfo": 1,
"category": 18,
"facility": 1,
"level": 6,
"unit": 775,
"opening": 471,
"areaElement": 496
},
"ontology": "facility-2.0"
},
{
"created": "2021-05-21T03:04:05.678Z",
"datasetId": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
"description": "Some other description or comment for the dataset.",
"datasetSources": {
"conversionIds": [
"15d21452-c9bb-27b6-5e79-743ca5c3205d"
],
"appendDatasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c"
},
"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
Name | Description |
---|---|
Dataset |
Az adathalmaz részletes adatai. |
Dataset |
Az Adathalmazlista API válaszmodellje. A válasz törzse tartalmazza az összes korábban létrehozott adathalmaz listáját. |
Dataset |
Információ az adathalmaz létrehozási kérésének részleteiről. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Dataset
Az adathalmaz részletes adatai.
Name | Típus | 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 szolgáltatás az adathalmazhoz számít. |
ontology |
string |
Az adathalmaz ontológiai verziója. |
DatasetListResult
Az Adathalmazlista API válaszmodellje. A válasz törzse tartalmazza az összes korábban létrehozott adathalmaz listáját.
Name | Típus | Description |
---|---|---|
datasets |
Dataset[] |
Az összes korábban létrehozott adathalmaz listája. |
nextLink |
string |
Ha van ilyen, a következő adatoldal helye. |
DatasetSources
Információ az adathalmaz létrehozási kérésének részleteiről.
Name | Típus | Description |
---|---|---|
appendDatasetId |
string |
Az aktuális adathalmaz létrehozásához hozzáfűzött adatkészlet. |
conversionIds |
string[] |
Az adathalmaz létrehozásához használt lista |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további adattípus. |
ErrorDetail
A hiba részletei.
Name | Típus | 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 | Típus | Description |
---|---|---|
error |
A hibaobjektum. |