Render - Get Map Tileset
Gebruik om metagegevens voor een tegelset op te halen.
Met de API Get Map Tileset kunnen gebruikers metagegevens aanvragen voor een tegelset.
GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versienummer van Azure Maps-API. Huidige versie is 2024-04-01. |
tileset
|
query | True |
Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster van vierkante tegels op vooraf ingestelde zoomniveaus. Elke tegelset heeft een tilesetId die kan worden gebruikt bij het indienen van aanvragen. De tilesetId voor tegelsets die zijn gemaakt met Behulp van Azure Maps Creator , worden gegenereerd via de API Tegelset maken. De kant-en-klare tegelsets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base. |
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 in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor hulp. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt 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-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.
Als u scenario's wilt implementeren, raden we u aan om 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 moet de
x-ms-client-id
header worden gebruikt om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.
De Authorization URL
is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-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 use cases.
- Zie Overzicht van Microsoft Identity Platform voor meer informatie over Microsoft Identity Platform.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.
Voor openbaar beschikbare toepassingen wordt aanbevolen om server-naar-servertoegang van Azure Maps REST API's te gebruiken, waar deze sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
header
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 over het verloop, de snelheid en de 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 oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren 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
{
"tilejson": "2.2.0",
"version": "1.0.0",
"attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">©2022 TomTom</a>",
"scheme": "xyz",
"tiles": [
"https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
],
"minzoom": 0,
"maxzoom": 22,
"bounds": [
-180,
-90,
180,
90
]
}
Definities
Name | Description |
---|---|
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Map |
Metagegevens voor een tegelset in de TegelJSON-indeling. |
TilesetID |
Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster van vierkante tegels op vooraf ingestelde zoomniveaus. Elke tegelset heeft een tilesetId die kan worden gebruikt bij het indienen van aanvragen. De tilesetId voor tegelsets die zijn gemaakt met Behulp van Azure Maps Creator , worden gegenereerd via de API Tegelset maken. De kant-en-klare tegelsets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base. |
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 |
De fout aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
MapTileset
Metagegevens voor een tegelset in de TegelJSON-indeling.
Name | Type | Description |
---|---|---|
attribution |
string |
Copyrightvermelding die op de kaart moet worden weergegeven. Implementaties kunnen besluiten om 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 bakentracering. |
bounds |
number[] |
De maximale hoeveelheid beschikbare kaarttegels. Grenzen MOETEN een gebied definiëren dat wordt gedekt door alle zoomniveaus. De grenzen worden weergegeven in WGS:84 breedte- en lengtegraadwaarden, in de volgorde links, onder, rechts, boven. Waarden kunnen gehele getallen of getallen met drijvende komma zijn. |
center |
number[] |
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 als HTML interpreteren. |
grids |
string[] |
Een matrix met interactiviteitseindpunten. |
legend |
string |
Een legenda die moet worden weergegeven met de kaart. Implementaties kunnen besluiten om 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 bakentracering. |
maxzoom |
integer |
Het maximale zoomniveau. |
minzoom |
integer |
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 |
Standaardinstelling: "xyz". "xyz" of "tms". Beïnvloedt de y-richting van de tegelcoördinaten. Er wordt uitgegaan van het global-mercator-profiel (ook wel Spherical Mercator genoemd). |
template |
string |
Een snorsjabloon die moet worden gebruikt voor het opmaken van gegevens uit rasters voor interactie. |
tilejson |
string |
Beschrijft de versie van de TileJSON-specificatie die wordt geïmplementeerd door dit JSON-object. |
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 |
Een semver.org versienummer van de stijl 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 van vierkante tegels op vooraf ingestelde zoomniveaus. Elke tegelset heeft een tilesetId die kan worden gebruikt bij het indienen van aanvragen. De tilesetId voor tegelsets die zijn gemaakt met Behulp van Azure Maps Creator , worden gegenereerd via de API Tegelset maken. De kant-en-klare tegelsets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base.
Name | Type | Description |
---|---|---|
microsoft.base |
string |
Een basiskaart is een standaardkaart met wegen, natuurlijke en kunstmatige kenmerken, samen met de labels voor deze kenmerken in een vectortegel. Ondersteunt zoomniveaus 0 tot en met 22. Notatie: vector (pbf). |
microsoft.base.darkgrey |
string |
Alle lagen met onze donkergrijze stijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.hybrid |
string |
Hiermee geeft u weg-, grens- en labelgegevens weer in een vectortegel. Ondersteunt zoomniveaus 0 tot en met 22. Notatie: vector (pbf). |
microsoft.base.hybrid.darkgrey |
string |
Weg-, grens- en labelgegevens in onze donkergrijze stijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.hybrid.road |
string |
Weg-, grens- en labelgegevens in onze hoofdstijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.labels |
string |
Geeft labels weer voor wegen, natuurlijke en kunstmatige kenmerken in een vectortegel. Ondersteunt zoomniveaus 0 tot en met 22. Notatie: vector (pbf). |
microsoft.base.labels.darkgrey |
string |
Label gegevens in onze donkergrijze stijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.labels.road |
string |
Label gegevens in onze hoofdstijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.road |
string |
Alle lagen met onze hoofdstijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.imagery |
string |
Een combinatie van satelliet- en luchtfoto's. Alleen beschikbaar in S1-prijs-SKU. Ondersteunt zoomniveaus 1 tot en met 19. Indeling: raster (jpeg). |
microsoft.terra.main |
string |
Gearceerde reliëf en terra lagen. Ondersteunt zoomniveaus 0 tot en met 6. Indeling: raster (png). |
microsoft.traffic.absolute |
string |
absolute verkeerstegels in vector |
microsoft.traffic.absolute.main |
string |
absolute verkeerstegels in raster in onze hoofdstijl. |
microsoft.traffic.delay |
string |
verkeertegels in vector |
microsoft.traffic.delay.main |
string |
verkeerstegels in raster in onze hoofdstijl |
microsoft.traffic.incident |
string |
incidenttegels in vector |
microsoft.traffic.reduced.main |
string |
tegels met minder verkeer in raster in onze hoofdstijl |
microsoft.traffic.relative |
string |
relatieve verkeertegels in vector |
microsoft.traffic.relative.dark |
string |
relatieve verkeerstegels in raster in onze donkere stijl. |
microsoft.traffic.relative.main |
string |
relatieve verkeerstegels in raster in onze hoofdstijl. |
microsoft.weather.infrared.main |
string |
Weer infraroodtegels. Nieuwste infrarood satellietbeelden tonen wolken op basis van hun temperatuur. Zie Dekking van weerservices in Azure Maps voor meer informatie. Zie Weerservices in Azure Maps voor meer informatie over de geretourneerde satellietgegevens. Ondersteunt zoomniveaus 0 tot en met 15. Indeling: raster (png). |
microsoft.weather.radar.main |
string |
Weerradartegels. Nieuwste weerradarbeelden, waaronder gebieden met regen, sneeuw, ijs en gemengde omstandigheden. Zie Azure Maps weather services coverage (Dekking van weerservices van Azure Maps) voor meer informatie over de dekking van de Azure Maps Weather-service. Zie Weerservices in Azure Maps voor meer informatie over radargegevens. Ondersteunt zoomniveaus 0 tot en met 15. Indeling: raster (png). |