Tileset - Get

Referentie

Service:: Maps Creator

API Version:: 2023-03-01-preview

Gebruik om de details van een tegelset op te halen.

Get-aanvraag indienen

De Get API is een HTTP-aanvraag GET die wordt gebruikt om de details van een tegelset op te halen.

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

URI-parameters

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij en eu.
tilesetId	path	True	string	De tegelset-id
api-version	query	True	string	Versienummer van Azure Maps API.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	Tileset	Aanvraag voor lijsttegelset is voltooid. De antwoordtekst bevat een lijst met alle tegelsets.
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

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

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

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
  ]
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
Feature	Functieconfiguratie voor tegelsetconfiguratie.
LayerObject	Laagobject voor configuratie van tegelset.
Tileset	Gedetailleerde informatie voor de gegevens.
TilesetConfiguration	Tegelsetconfiguratie op het hoogste niveau. Een tegelsetconfiguratie is een JSON-object dat de volgende velden op het hoogste niveau moet bevatten:

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Feature

Functieconfiguratie voor tegelsetconfiguratie.

Name	Type	Description
featureClasses	string[]	De lijst met functieklassen die worden gebruikt om de laag te bouwen. De geldige functieklassen zijn te vinden in de ontologiedefinitie. Bijvoorbeeld Facility Ontology
filter	object	Hiermee verwijdert u functies die niet overeenkomen met een patroon. Raadpleeg maplibre-filterexpressie

LayerObject

Laagobject voor configuratie van tegelset.

Name	Type	Description
features	Feature	Hiermee geeft u de functieklassen en filters op.
maxZoom	integer	Het hoogste zoomniveau voor de laag die moet worden gebouwd.
minZoom	integer	Het laagste zoomniveau voor de laag die moet worden gebouwd.

Tileset

Gedetailleerde informatie voor de gegevens.

Name	Type	Description
bbox	number[]	Begrenzingsvak waarin alle kenmerken van de tegelset zijn geplaatst. Gebruikte projectie - EPSG:3857. Indeling: 'minLon, minLat, maxLon, maxLat'.
datasetId	string	De unieke gegevensset-id die wordt gebruikt om de tegelset te maken.
defaultMapConfigurationId	string	De standaard gegenereerde kaartconfiguratie-id voor de tegelset
description	string	De beschrijving die de aanroeper heeft opgegeven bij het maken van de tegelset. Maximale lengte 1024 tekens.
maxZoom	integer	De tegel op het hoogste tegelniveau die is gegenereerd voor de tegelset.
minZoom	integer	De tegel op het laagste zoomniveau die is gegenereerd voor de tegelset.
ontology	string	De ontologieversie van deze gegevensset.
tilesetConfiguration	TilesetConfiguration	Tegelsetconfiguratie die wordt gebruikt om de tegelset te bouwen.
tilesetId	string	De unieke tegelset-id voor de tegelset.

TilesetConfiguration

Tegelsetconfiguratie op het hoogste niveau. Een tegelsetconfiguratie is een JSON-object dat de volgende velden op het hoogste niveau moet bevatten:

Name	Type	Description
layers	<string, LayerObject>	De namen van de lagen en hun configuratieopties. Het object configuratielagen bevat sleutel-waardeparen die de namen van tegellagen aan hun configuratie koppelen. Voor elk sleutel-waardepaar is de sleutel de naam van de laag en de waarde is een LayerObject met de configuratie en opties voor de laag. Elke laag moet een naam hebben. Dit is de unieke id voor de gegevenslaag in uw uiteindelijke tegelset. In elke tegelset moet elke laagnaam uniek zijn. De laagnaam moet een tekenreeks zijn met alleen onderstrepingstekens (_) en alfanumerieke tekens. Het bijbehorende LayerObject voor elke laagnaam beschrijft hoe die vectortegellaag moet worden gemaakt. Hiermee wordt aangegeven welke functieklassen functiegegevens moeten worden opgehaald, hoe nauwkeurig de gegevens zijn via zoomniveaus en hoe functies moeten worden getransformeerd en weergegeven in tegels.
version	integer	De versie van Azure Maps Tiling-serviceconfiguratieverwijzing die door de tegelsetconfiguratie wordt gebruikt. Momenteel is alleen versie 1 toegestaan. Als u een andere versie gebruikt dan de huidige versie of een eerdere versie, resulteert dit in een fout.

Delen via