WFS - Get Landing Page
A használatával lekérheti az API-definíciókra, megfelelőségi utasításokra és metaadatokra mutató hivatkozásokat egy szolgáltatásgyűjteményről.
Az Get Landing Page
API egy HTTP-kérés GET
, amely hivatkozásokat biztosít az API-definícióra, a megfelelőségi utasításokra és a megadott adatkészletben található szolgáltatásgyűjteményekre vonatkozó metaadatokra.
A WFS API az Open Geospatial Consortium API szabványt követi azadathalmazok lekérdezéséhez szükséges funkciókhoz.
Egy adatkészlet több funkciógyűjteményből áll. A szolgáltatásgyűjtemények hasonló típusú szolgáltatások gyűjteményei, amelyek egy közös sémán alapulnak.
Kezdőlap kérésének elküldése
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/?api-version=2.0
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
dataset
|
path | True |
string |
Annak az adathalmaznak az azonosítója, amelyből lekérdezhető. |
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 |
Oké |
|
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.
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, 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.
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, 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.
Type:
apiKey
In:
header
Példák
GetLandingPage
Sample Request
GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/?api-version=2.0
Sample Response
{
"ontology": "Facility-2.0",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4",
"rel": "self",
"title": "Azure Maps WFS"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api",
"rel": "service",
"title": "The API definition"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance",
"rel": "conformance",
"title": "WFS 3.0 conformance classes implemented by this server"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/version",
"rel": "data",
"title": "The version information"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections",
"rel": "data",
"title": "Metadata about the feature collections"
}
]
}
Definíciók
Name | Description |
---|---|
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Landing |
|
WFSEndpoint |
Hivatkozások más WFS-végpontokra |
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. |
LandingPageResult
Name | Típus | Description |
---|---|---|
links |
Más WFS-végpontokra mutató hivatkozások. |
|
ontology |
string |
Az adathalmaz ontológiai verziója. |
WFSEndpointLink
Hivatkozások más WFS-végpontokra
Name | Típus | Description |
---|---|---|
href |
string |
A hivatkozás célja. |
hreflang |
string |
Egy tipp, amely azt jelzi, hogy a hivatkozás elhalasztásának eredménye milyen nyelven jelenik meg. |
rel |
string |
A relációs típus. |
title |
string |
Egy hivatkozás céljának címkézésére szolgál, hogy az emberi olvasásra alkalmas azonosítóként (például menübejegyzésként) használható a Content-Language fejlécmező által jelzett nyelven (ha van ilyen). |
type |
string |
Egy tipp, amely jelzi, hogy a hivatkozás elhalasztásának eredménye milyen médiatípusúnak kell lennie. |