Routeset - List

Referencia

Szolgáltatás:: Maps Creator

API-verzió:: 2023-03-01-preview

Az útvonalkészletek listájának lekéréséhez használja a parancsot.

A Creator lehetővé teszi a privát beltéri térképadatokon alapuló alkalmazások fejlesztését Azure Maps API-k és SDK-k használatával. Az Azure Maps Creator fogalmait és eszközeit a Beltéri térképek készítője című cikkben tekinthet meg.

Listakérés elküldése

Az List API egy HTTP-kérésGET, amely lehetővé teszi, hogy a hívó lekérje az aktuális Azure Maps Creator-fiók összes útvonalkészletének listáját.

GET https://{geography}.atlas.microsoft.com/routesets?api-version=2023-03-01-preview

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	RoutesetsList	Az útvonalkészlet-kérelem listázása sikeresen befejeződött. A válasz törzse tartalmazza az összes útvonalkészlet listáját.
Other Status Codes	ErrorResponse	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 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 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 Web SDK használata lehetővé teszi az alkalmazások 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 a munkahelyi, iskolai és vendégfelhasználói fiókokat támogatja, de nem támogatja a személyes fiókokat.

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

Enumerate all routesets for a given subscription

Mintakérelem

HTTP

GET https://us.atlas.microsoft.com/routesets?api-version=2023-03-01-preview

Mintaválasz

Állapotkód:: 200

{
  "routesets": [
    {
      "routesetId": "[routesetid 1]",
      "datasetId": "[datasetid A]",
      "description": "routeset_1",
      "facilities": [
        {
          "facilityId": "Facility_1",
          "levelOrdinals": [
            -1,
            0,
            1
          ]
        }
      ],
      "created": "2022-09-01T00:00:00.000Z"
    },
    {
      "routesetId": "[routesetid 2]",
      "datasetId": "[datasetid A]",
      "description": "routeset_2",
      "facilities": [
        {
          "facilityId": "Facility_2",
          "levelOrdinals": [
            0,
            1,
            2,
            3
          ]
        }
      ],
      "created": "2022-09-01T00:00:00.000Z"
    }
  ]
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
FacilityDetails	Az útvonalkészlet egyes létesítményeinek részletei.
Routeset	Az útvonalkészlet részletes információi.
RoutesetsList	A Routeset List API válaszmodellje. Az összes útvonalkészlet listáját adja vissza.

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	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

FacilityDetails

Az útvonalkészlet egyes létesítményeinek részletei.

Name	Típus	Description
facilityId	string	Annak a struktúrának az azonosítója, amelyből az útvonalkészlet létre lett hozva.
levelOrdinals	number[]	A létesítményen belüli szintazonosítók.

Routeset

Az útvonalkészlet részletes információi.

Name	Típus	Description
created	string	Az útvonalkészlet-objektum létrehozásának dátuma és időpontja.
datasetId	string	Az útvonalkészlet létrehozásához használt adatkészlet azonosítója.
description	string	Az épület leíráskódja az ontológiai verziószámmal.
facilities	FacilityDetails[]	A létesítmény adatai és az épületszintű sorszámok.
routesetId	string	Az útvonalkészlet egyedi azonosítója.

RoutesetsList

A Routeset List API válaszmodellje. Az összes útvonalkészlet listáját adja vissza.

Name	Típus	Description
nextLink	string	Ha van ilyen, a következő adatoldal helye.
routesets	Routeset[]	Az összes útvonalkészlet listája.

Megosztás a következőn keresztül: