Tileset - List

Referens

Tjänst:: Maps Creator

API-version:: 2.0

Använd för att hämta en lista över paneluppsättningar.

Not

Azure Maps Creator-

Inomhuskartetjänsten för Azure Maps Creator är nu inaktuell och kommer att dras tillbaka den 25-09-30. Mer information finns i End of Life Announcement of Azure Maps Creator.

Skicka listbegäran

List-API:et är en HTTP-GET begäran som används för att hämta en lista över alla befintliga paneluppsättningar.

GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0

URI-parametrar

Name	I	Obligatorisk	Typ	Description
geography	path	True	string	Den här parametern anger var Azure Maps Creator-resursen finns. Giltiga värden är vi och EU.
api-version	query	True	string	Versionsnummer för Azure Maps API.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar för vägledning.

Svar

Name	Typ	Description
200 OK	TilesetListResult	Listans paneluppsättningsbegäran har slutförts. Svarstexten innehåller en lista över alla paneluppsättningar.
Other Status Codes	ErrorResponse	Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Anteckningar

Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Get a list of all tilesets

Exempelbegäran

HTTP

GET https://us.atlas.microsoft.com/tilesets?api-version=2.0

Exempelsvar

Statuskod:: 200

{
  "tilesets": [
    {
      "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84",
      "datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b",
      "description": "My first tileset",
      "minZoom": 16,
      "maxZoom": 18,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ]
    },
    {
      "tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3",
      "datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad",
      "description": "My second tileset",
      "minZoom": 19,
      "maxZoom": 19,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ]
    }
  ]
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
Tileset	Detaljerad information för data.
TilesetListResult	Svarsmodellen för API:et paneluppsättningslista. Returnerar en lista över alla paneluppsättningar.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

Tileset

Objekt

Detaljerad information för data.

Name	Typ	Description
bbox	number[] (double)	Avgränsningsruta som alla funktioner i paneluppsättningen ligger inom. Projektion används – EPSG:3857. Format: "minLon, minLat, maxLon, maxLat".
datasetId	string	Det unika datamängds-ID som används för att skapa paneluppsättningen.
description	string	Beskrivningen som anroparen angav när paneluppsättningen skapades. Maximal längd på 1 024 tecken.
maxZoom	integer	Den högsta panelzoomnivåpanelen som genererats för paneluppsättningen.
minZoom	integer	Den lägsta panelzoomnivåpanelen som genererats för paneluppsättningen.
ontology	string	Ontologiversionen av den här datamängden.
tilesetId	string	Det unika paneluppsättnings-ID:t för paneluppsättningen.

TilesetListResult

Objekt

Svarsmodellen för API:et paneluppsättningslista. Returnerar en lista över alla paneluppsättningar.

Name	Typ	Description
nextLink	string	Om det finns plats för nästa sida med data.
tilesets	Tileset[]	En lista över alla paneluppsättningar.

Dela via

Tileset - List

Skicka listbegäran

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Anteckningar

Omfattningar

subscription-key

SAS Token

Exempel

Get a list of all tilesets

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Tileset

TilesetListResult

Ytterligare resurser