Features - Get Landing Page

Referencia

Szolgáltatás:: Maps Creator

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

Az API-definícióra, megfelelőségi utasításokra és metaadatokra mutató hivatkozások lekérésére szolgál egy adott funkciógyűjteményhez.

Jegyzet

Az Azure Maps Creator kivonása

Az Azure Maps Creator beltéri térképszolgáltatása elavult, és 25.09.30-án megszűnik. További információkért lásd az Azure Maps Creator élettartamának megszűnését ismertető közleményét.

A Features API a Creatorrésze, amely lehetővé teszi a privát beltéri térképadatokon alapuló alkalmazások fejlesztését az Azure Maps API és az SDK használatával. A Features GET API-k a Open Geospatial Consortium API - Features – 1. rész: Alapvető helyesbítés standard Adathalmazoklekérdezéséhez. Az adathalmazok több funkciógyűjteményből állnak, amelyek közös séma által definiált szolgáltatásokból állnak.

Kezdőlap kérésének elküldése

A Get Landing Page API egy HTTP-GET-kérés, amely hivatkozásokat biztosít az API-definícióra, a megfelelőségi utasításokra és a megadott adatkészlet funkcióira vonatkozó metaadatokra.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
datasetId	path	True	string	Annak az adatkészletnek az azonosítója, amelyből lekérdezhető.
geography	path	True	string	Ez a paraméter határozza meg, hogy hol található az Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	Az Azure Maps API verziószáma.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Megadja, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Az Azure Maps-fiók egyedi azonosítóját jelöli, amely az Azure Maps felügyeleti sík fiók API-jából kérhető le. A Microsoft Entra ID-biztonság Azure Mapsben való használatához az alábbi cikkeket útmutatásért.

Válaszok

Name	Típus	Description
200 OK	LandingPageResult	Oké
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2 Folyamatok. Ha Azure-beli szerepköralapú hozzáférés- vezérléssel párosítva szabályozható az 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örön vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörön keresztül.

Forgatókönyvek implementálásához javasoljuk, hogy tekintse meg hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást kínál az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Notes

Ez a biztonsági definíciós megköveteli, hogy a x-ms-client-id fejléc használatával jelezze, hogy melyik Azure Maps-erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps felügyeleti API-érhető el.

A 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és a Azure felügyeleti síkjáról van konfigurálva, az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esethez.

Az Azure Active Directory jelenleg 1.0-s vagy 2.0-s verziós támogatja a Munkahelyi, Iskolai és Vendég verziót, 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 jön létre, ha Azure Maps-erőforrást hoz létre az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a kulccsal minden alkalmazás jogosult az összes REST API elérésére. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyhez ki vannak adva.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy az Azure Maps REST API-k kiszolgálóról kiszolgálóra történő elérését használja, ahol ez a kulcs biztonságosan tárolható.

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 a Azure Maps-erőforráson az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult az Azure szerepköralapú hozzáférés-vezérlőivel való hozzáférésre, valamint az adott jogkivonat lejáratának, sebességének és régióinak részletes szabályozására. Más szóval az SAS-jogkivonat segítségével az alkalmazások biztonságosabban szabályozhatják a hozzáférést, mint a megosztott kulcs.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfigurálja a -fiók erőforrás- engedélyezett forrásainak listáját a renderelési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

GetLandingPage

Mintakérelem

HTTP

GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4?api-version=2023-03-01-preview

Mintaválasz

Állapotkód:: 200

{
  "ontology": "Facility-2.0",
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4",
      "rel": "self",
      "title": "Azure Maps Features"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api",
      "rel": "service-desc",
      "title": "The API definition"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance",
      "rel": "conformance",
      "title": "Conformance classes implemented by Features APIs"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections",
      "rel": "data",
      "title": "Information about the feature collections"
    }
  ]
}

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
FeaturesEndpointLink	Más szolgáltatások végpontjaira mutató hivatkozások. A kapcsolatkapcsolatokkal kapcsolatos további részletekért látogasson el az OGC API – Szolgáltatások – 1. rész szabványra.
LandingPageResult	Válasz a kezdőlapra irányuló sikeres kérés után.

ErrorAdditionalInfo

Objektum

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 információtípus.

ErrorDetail

Objektum

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 hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

FeaturesEndpointLink

Objektum

Más szolgáltatások végpontjaira mutató hivatkozások. A kapcsolatkapcsolatokkal kapcsolatos további részletekért látogasson el az OGC API – Szolgáltatások – 1. rész szabványra.

Name	Típus	Description
href	string (uri)	A hivatkozás célja.
rel	string	A relációs típus.
title	string	A hivatkozás célhelyének megjelölésére szolgál, így az emberi olvasásra alkalmas azonosítóként (például menübejegyzésként) használható a Tartalom-nyelv fejléc mező által jelzett nyelven (ha van ilyen).

LandingPageResult

Objektum

Válasz a kezdőlapra irányuló sikeres kérés után.

Name	Típus	Description
links	FeaturesEndpointLink[]	Más szolgáltatások végpontjaira mutató hivatkozások.
ontology	string	Az adathalmaz ontológiai verziója.

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

Features - Get Landing Page

Kezdőlap kérésének elküldése

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

AADToken

Notes

Hatókörök

subscription-key

SAS Token

Példák

GetLandingPage

Mintakérelem

Mintaválasz

Definíciók

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeaturesEndpointLink

LandingPageResult