Tileset - Get

Referens

Service:: Maps Creator

API Version:: 2023-03-01-preview

Använd för att hämta information om en paneluppsättning.

Skicka hämta begäran

API:et Get är en HTTP-begäran GET som används för att hämta information om en paneluppsättning.

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

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.
tilesetId	path	True	string	Paneluppsättnings-ID:t
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äkerhetsmodell. 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.

Svar

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

Säkerhet

AADToken

Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure 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 resurskonto 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 för att 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 ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

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

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, 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.

För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

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

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

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

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

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 av 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 säkrare 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.

Type: apiKey
In: header

Exempel

Gets the details for a single tileset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview

Sample Response

Status code:: 200

{
  "tilesetId": "{tilesetId}",
  "datasetId": "{datasetId}",
  "description": "My first tileset",
  "minZoom": 16,
  "maxZoom": 18,
  "bbox": [
    -122.13595,
    47.636524,
    -122.1329,
    47.637525
  ]
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
Feature	Funktionskonfiguration för paneluppsättningskonfiguration.
LayerObject	Layer-objekt för paneluppsättningskonfiguration.
Tileset	Information om data.
TilesetConfiguration	Paneluppsättningens konfigurationsfält på den översta nivån. En paneluppsättningskonfiguration är ett JSON-objekt som måste innehålla följande fält på den översta nivån:

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

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

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

Feature

Funktionskonfiguration för paneluppsättningskonfiguration.

Name	Typ	Description
featureClasses	string[]	Listan över funktionsklasser som ska användas för att skapa lagret. Giltiga funktionsklasser finns i dess ontologidefinition. Till exempel Anläggnings ontologi
filter	object	Tar bort funktioner som inte matchar ett mönster. Se MapLibre-filteruttryck

LayerObject

Layer-objekt för paneluppsättningskonfiguration.

Name	Typ	Description
features	Feature	Anger funktionsklasser och filter.
maxZoom	integer	Den högsta zoomnivån för lagret som ska byggas.
minZoom	integer	Den lägsta zoomnivån för lagret som ska byggas.

Tileset

Information om data.

Name	Typ	Description
bbox	number[]	Avgränsningsruta som alla funktioner i paneluppsättningen ligger inom. Projektion används – EPSG:3857. Format: "minLon, minLat, maxLon, maxLat".
datasetId	string	Det unika datauppsättnings-ID som användes för att skapa paneluppsättningen.
defaultMapConfigurationId	string	Standardgenererat mappningskonfigurations-ID för 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 datauppsättningen.
tilesetConfiguration	TilesetConfiguration	Paneluppsättningskonfiguration som används för att skapa paneluppsättningen.
tilesetId	string	Det unika paneluppsättnings-ID:t för paneluppsättningen.

TilesetConfiguration

Paneluppsättningens konfigurationsfält på den översta nivån. En paneluppsättningskonfiguration är ett JSON-objekt som måste innehålla följande fält på den översta nivån:

Name	Typ	Description
layers	<string, LayerObject>	Namnen på lagren och deras konfigurationsalternativ. Objektet för konfigurationsskikt innehåller nyckel/värde-par som associerar namnen på panelskikten med deras konfiguration. För varje nyckel/värde-par är nyckeln namnet på lagret och värdet är en LayerObject som innehåller konfigurationen och alternativen för lagret. Varje lager måste ha ett namn. Det här är den unika identifieraren för datalagret i den slutliga paneluppsättningen. Varje lagernamn måste vara unikt i valfri paneluppsättning. Lagernamnet måste vara en sträng med endast understreck (_) och alfanumeriska tecken. Motsvarande LayerObject för varje lagernamn beskriver hur vektorpanellagret ska skapas. Den anger vilka funktionsklasser som ska hämta funktionsdata, precisionen för data via zoomnivåer och hur du transformerar funktioner och renderar dem till paneler.
version	integer	Den version av Azure Maps konfigurationsreferensen för tilingtjänsten som används av paneluppsättningskonfigurationen. För närvarande är endast version 1 tillåten. Om du använder någon annan version av den aktuella versionen eller en tidigare version resulterar det i ett fel.