Render - Get Map Tileset

Hiermee haalt u metagegevens op voor een tegelset.
Met de GET Map Tileset-API kunnen gebruikers metagegevens voor een tegelset aanvragen.

GET {endpoint}/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

URI-parameters

Name In Vereist Type Description
endpoint
path True

string (uri)

De hostnaam van de Azure Maps-service. Gebruik https://atlas.microsoft.com voor de Azure publieke cloud. Om een specifieke Azure Maps geografie of een soevereine cloud te targeten, zie Azure Maps geografische reikwijdte.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

tilesetId
query True

TilesetID

Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster met vierkante tegels op vooraf ingestelde zoomniveaus. Elke tegelset heeft een tegelsetId die u kunt gebruiken bij het indienen van aanvragen. De kant-en-klare tilesets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-id

string

Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke ID voor het Azure Maps-account kan worden verkregen via de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps.

Antwoorden

Name Type Description
200 OK

MapTileset

De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

AadToken

Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts 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 om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Note

  • Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-.
  • De Authorization URL is specifiek voor het exemplaar van de openbare Azure-cloud. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties.
  • Het op rollen gebaseerde 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 configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
  • Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in 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 worden uitgegeven.

Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS 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 voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successful Tileset Request

Voorbeeldaanvraag

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

Voorbeeldrespons

{
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "bounds": [
    -180,
    -90,
    180,
    90
  ],
  "maxzoom": 22,
  "minzoom": 0,
  "scheme": "xyz",
  "tilejson": "2.2.0",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "version": "1.0.0"
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

MapTileset

Metagegevens voor een tegelset in de TileJSON-indeling.

TilesetID

Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster met vierkante tegels op vooraf ingestelde zoomniveaus. Elke tegelset heeft een tegelsetId die u kunt gebruiken bij het indienen van aanvragen. De kant-en-klare tilesets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error

ErrorDetail

Het foutobject.

MapTileset

Metagegevens voor een tegelset in de TileJSON-indeling.

Name Type Description
attribution

string

Copyright toeschrijving die op de kaart moet worden weergegeven. Implementaties kunnen besluiten dit te behandelen als HTML- of letterlijke tekst. Om veiligheidsredenen moet u er absoluut voor zorgen dat dit veld niet kan worden misbruikt als vector voor XSS- of beacontracering.

bounds

number[] (float)

De maximale omvang van beschikbare kaarttegels. Grenzen MOETEN een gebied definiëren dat wordt gedekt door alle zoomniveaus. De grenzen worden weergegeven in WGS:84 breedtegraad- en lengtegraadwaarden, in de volgorde links, onder, rechts, boven. Waarden kunnen gehele getallen of drijvendekommanummers zijn.

center

number[] (float)

De standaardlocatie van de tegelset in de vorm [lengtegraad, breedtegraad, zoom]. Het zoomniveau MOET tussen minzoom en maxzoom zijn. Implementaties kunnen deze waarde gebruiken om de standaardlocatie in te stellen.

data

string[]

Een matrix met gegevensbestanden in GeoJSON-indeling.

description

string

Tekstbeschrijving van de tegelset. De beschrijving kan elk juridisch karakter bevatten. Implementaties MOGEN de beschrijving NIET interpreteren als HTML.

grids

string[]

Een matrix van interactiviteit-eindpunten.

legend

string

Een legenda die met de kaart moet worden weergegeven. Implementaties kunnen besluiten dit te behandelen als HTML- of letterlijke tekst. Om veiligheidsredenen moet u er absoluut voor zorgen dat dit veld niet kan worden misbruikt als vector voor XSS- of beacontracering.

maxzoom

integer (int32)

minimum: 0
maximum: 30

Het maximale zoomniveau.

minzoom

integer (int32)

minimum: 0
maximum: 30

Het minimale zoomniveau.

name

string

Een naam die de tegelset beschrijft. De naam kan elk juridisch karakter bevatten. Implementaties MOGEN de naam NIET interpreteren als HTML.

scheme

string

Standaard: 'xyz'. XYZ of TMS. Beïnvloedt de y-richting van de tegelcoördinaten. Het profiel global-mercator (ook wel Spherical Mercator genoemd) wordt aangenomen.

template

string

Een snorachesjabloon die moet worden gebruikt voor het opmaken van gegevens uit rasters voor interactie.

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Beschrijft de versie van de TileJSON-specificatie die door dit JSON-object wordt geïmplementeerd.

tiles

string[]

Een matrix met tegeleindpunten. Als er meerdere eindpunten zijn opgegeven, kunnen clients elke combinatie van eindpunten gebruiken. Alle eindpunten MOETEN dezelfde inhoud retourneren voor dezelfde URL. De matrix MOET ten minste één eindpunt bevatten.

version

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Een semver.org stijlversienummer voor de tegels in de tegelset. Wanneer wijzigingen in tegels worden geïntroduceerd, moet de secundaire versie worden gewijzigd.

TilesetID

Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster met vierkante tegels op vooraf ingestelde zoomniveaus. Elke tegelset heeft een tegelsetId die u kunt gebruiken bij het indienen van aanvragen. De kant-en-klare tilesets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base.

Waarde Description
microsoft.base

Een basiskaart is een standaardkaart die wegen, natuurlijke en kunstmatige kenmerken weergeeft, samen met de labels voor deze kenmerken in een vectortegel.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: vector (pbf).

microsoft.base.labels

Geeft labels weer voor wegen, natuurlijke en kunstmatige kenmerken in een vectortegel.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: vector (pbf).

microsoft.base.hybrid

Geeft weg-, grens- en labelgegevens weer in een vectortegel.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: vector (pbf).

microsoft.terra.main

Gearceerde opluchting en terralagen.

Ondersteunt zoomniveaus 0 tot en met 6. Indeling: raster (png).

microsoft.base.road

Alle lagen met onze hoofdstijl.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png).

microsoft.base.darkgrey

Alle lagen met onze donkergrijze stijl.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png).

microsoft.base.labels.road

Label gegevens in onze hoofdstijl.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png).

microsoft.base.labels.darkgrey

Labelgegevens in onze donkergrijze stijl.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png).

microsoft.base.hybrid.road

Weg-, grens- en labelgegevens in onze hoofdstijl.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png).

microsoft.base.hybrid.darkgrey

Weg-, grens- en labelgegevens in onze donkergrijze stijl.

Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png).

microsoft.imagery

Een combinatie van satelliet- of luchtfoto's. Alleen beschikbaar in S1- en G2-prijs-SKU.

Ondersteunt zoomniveaus 1 tot en met 19. Indeling: raster (png).

microsoft.weather.radar.main

Weerradartegels. Nieuwste weerradarbeelden, waaronder regengebieden, sneeuw, ijs en gemengde omstandigheden. Voor meer informatie over de dekking van de Azure Maps Weather Service, zie Azure Maps weerdiensten verslaggeving. Voor meer informatie over radargegevens, zie Weerdiensten in Azure Maps.

Ondersteunt zoomniveaus 0 tot en met 15. Indeling: raster (png).

microsoft.weather.infrared.main

Weer infraroodtegels. Nieuwste infrarood satellietbeelden tonen wolken op hun temperatuur. Voor meer informatie, zie Azure Maps weerdienst verslaggeving. Voor meer informatie over de teruggegeven satellietgegevens, zie Weerdiensten in Azure Maps.

Ondersteunt zoomniveaus 0 tot en met 15. Indeling: raster (png).

microsoft.traffic.absolute

absolute verkeerstegels in vector

microsoft.traffic.absolute.main

absolute verkeerstegels in raster in onze hoofdstijl.

microsoft.traffic.relative

relatieve verkeerstegels in vector

microsoft.traffic.relative.main

relatieve verkeerstegels in raster in onze hoofdstijl.

microsoft.traffic.relative.dark

relatieve verkeerstegels in raster in onze donkere stijl.

microsoft.traffic.delay

verkeerstegels in vector

microsoft.traffic.delay.main

verkeerstegels in raster in onze hoofdstijl

microsoft.traffic.reduced.main

minder verkeerstegels in raster in onze hoofdstijl

microsoft.traffic.incident

incidenttegels in vector