Dataset - List
Slouží k získání seznamu datových sad.
Odeslat žádost o seznam
Pokud chcete zobrazit seznam všech datových sad, vydejte GET
požadavek bez dalších parametrů.
Odpověď na výpis dat
Tady je ukázková odpověď vracející timestamp
, datasetId
, description
datasetSources
, a ontology
ze 2 prostředků datové sady:
{
"datasets": [
{
"timestamp": "2020-01-01T22:50:48.123Z",
"datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"description": "Some description or comment for the dataset.",
"datasetSources": {
"udids": [
"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
}
},
{
"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"
],
"udids": [
"15d21452-c9bb-27b6-5e79-743ca5c3205d"
]
"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=2023-03-01-preview
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
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 je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Žádost o datovou sadu se úspěšně dokončila. Tělo odpovědi obsahuje dříve vytvořenou datovou sadu. |
|
Other Status Codes |
Došlo k neočekávané chybě. |
Zabezpečení
AADToken
Toto jsou toky Azure Active Directory OAuth2 . 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 složené 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 pro konkrétní rozhraní API a obory.
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. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory.
* Ří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í.
- Azure Active Directory verze 1.0 nebo 2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
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ůže každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.
U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.
Typ:
apiKey
V:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku 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 autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečený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 účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Typ:
apiKey
V:
header
Příklady
List all the previously created datasets
Ukázkový požadavek
GET https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview
Ukázková odpověď
{
"datasets": [
{
"created": "2021-05-21T03:04:05.678Z",
"datasetId": "{datasetId}",
"description": "Some description or comment for the dataset.",
"datasetSources": {
"udids": [
"{udid}"
]
},
"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": "{datasetId}",
"description": "Some other description or comment for the dataset.",
"datasetSources": {
"conversionIds": [
"{conversionId}"
],
"udids": [
"{udid}"
],
"appendDatasetId": "{appendDatasetId}"
},
"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ě |
Dataset |
Model odpovědí pro rozhraní API pro seznam datových sad. Text odpovědi bude obsahovat seznam všech dříve vytvořených datových sad. |
Dataset |
Informace o podrobnostech žádosti o vytvoření datové sady |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
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 |
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. |
DatasetListResult
Model odpovědí pro rozhraní API pro seznam datových sad. Text odpovědi bude obsahovat seznam všech dříve vytvořených datových sad.
Name | Typ | Description |
---|---|---|
datasets |
Dataset[] |
Seznam všech dříve vytvořených datových sad |
nextLink |
string |
Pokud je k dispozici, umístění další stránky dat. |
DatasetSources
Informace o podrobnostech žádosti o vytvoření datové sady
Name | Typ | Description |
---|---|---|
appendDatasetId |
string |
Datová sada, která byla připojena k vytvoření aktuální datové sady. |
conversionIds |
string[] |
Slouží |
udids |
string[] |
Slouží |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |