Render - Get Map Tileset
Dient zum Abrufen von Metadaten für ein Kachelset.
Mit der Get Map-Kachelnet-API können Benutzer Metadaten für ein Kachelset anfordern.
GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps-API. Die aktuelle Version ist der 01.04.2024. |
|
tileset
|
query | True |
Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster von quadratischen Kacheln auf voreingestellten Zoomebenen unterteilt sind. Jedes Kachelset verfügt über eine tilesetId-, die beim Senden von Anforderungen verwendet werden soll. Die von Azure Maps bereitgestellten einsatzbereiten Kacheln sind unten aufgeführt. Beispiel: microsoft.base. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-id |
string |
Gibt das Konto an, das für die Verwendung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann über die Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
OKAY |
|
| Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.
Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden.
Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen.
* Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.
Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
header
SAS Token
Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.
Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Successful Tileset Request
Beispielanforderung
GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base
Beispiel für eine Antwort
{
"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
]
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
Map |
Metadaten für ein Kachelset im TileJSON-Format. |
| TilesetID |
Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster von quadratischen Kacheln auf voreingestellten Zoomebenen unterteilt sind. Jedes Kachelset verfügt über eine tilesetId-, die beim Senden von Anforderungen verwendet werden soll. Die von Azure Maps bereitgestellten einsatzbereiten Kacheln sind unten aufgeführt. Beispiel: microsoft.base. |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
object |
Die zusätzlichen Informationen. |
| type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
MapTileset
Metadaten für ein Kachelset im TileJSON-Format.
| Name | Typ | Beschreibung |
|---|---|---|
| attribution |
string |
Copyright-Zuordnung, die auf der Karte angezeigt werden soll. Implementierungen KÖNNEN dies als HTML- oder Literaltext behandeln. Stellen Sie aus Sicherheitsgründen sicher, dass dieses Feld nicht als Vektor für die XSS- oder Beacon-Verfolgung missbraucht werden kann. |
| bounds |
number[] |
Der maximale Umfang der verfügbaren Kartenkacheln. Grenzen MÜSSEN einen Bereich definieren, der von allen Zoomstufen abgedeckt wird. Die Grenzen werden in WGS:84 Breiten- und Längengradwerten in der Reihenfolge links, unten, rechts, oben dargestellt. Werte können ganze Zahlen oder Gleitkommazahlen sein. |
| center |
number[] |
Die Standardposition des Kachelsets im Formular [Längengrad, Breitengrad, Zoom]. Der Zoomfaktor MUSS zwischen Minzoom und Maxzoom liegen. Implementierungen können diesen Wert verwenden, um den Standardspeicherort festzulegen. |
| data |
string[] |
Ein Array von Datendateien im GeoJSON-Format. |
| description |
string |
Textbeschreibung des Kachelsets. Die Beschreibung kann ein beliebiges rechtliches Zeichen enthalten. Implementierungen SOLLTEN die Beschreibung NICHT als HTML interpretieren. |
| grids |
string[] |
Ein Array von Interaktivitätsendpunkten. |
| legend |
string |
Eine Legende, die mit der Karte angezeigt werden soll. Implementierungen KÖNNEN dies als HTML- oder Literaltext behandeln. Stellen Sie aus Sicherheitsgründen sicher, dass dieses Feld nicht als Vektor für die XSS- oder Beacon-Verfolgung missbraucht werden kann. |
| maxzoom |
integer minimum: 0maximum: 30 |
Der maximale Zoomfaktor. |
| minzoom |
integer minimum: 0maximum: 30 |
Der minimale Zoomfaktor. |
| name |
string |
Ein Name, der das Kachelset beschreibt. Der Name kann ein beliebiges rechtliches Zeichen enthalten. Implementierungen SOLLTEN den Namen NICHT als HTML interpretieren. |
| scheme |
string |
Standard: "xyz". Entweder "xyz" oder "tms". Beeinflusst die y-Richtung der Kachelkoordinaten. Das Global-Mercator-Profil (auch bekannt als Spherical Mercator) wird angenommen. |
| template |
string |
Eine Mustache-Vorlage, die zum Formatieren von Daten aus Rastern für die Interaktion verwendet werden soll. |
| tilejson |
string pattern: \d+\.\d+\.\d+\w?[\w\d]* |
Beschreibt die Version der TileJSON-Spezifikation, die von diesem JSON-Objekt implementiert wird. |
| tiles |
string[] |
Ein Array von Kachelendpunkten. Wenn mehrere Endpunkte angegeben sind, können Clients eine beliebige Kombination von Endpunkten verwenden. Alle Endpunkte MÜSSEN denselben Inhalt für dieselbe URL zurückgeben. Das Array MUSS mindestens einen Endpunkt enthalten. |
| version |
string pattern: \d+\.\d+\.\d+\w?[\w\d]* |
Eine semver.org Versionsnummer für die Kacheln, die im Kachelsatz enthalten sind. Wenn Änderungen über Kacheln hinweg eingeführt werden, muss sich die Nebenversion ändern. |
TilesetID
Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster von quadratischen Kacheln auf voreingestellten Zoomebenen unterteilt sind. Jedes Kachelset verfügt über eine tilesetId-, die beim Senden von Anforderungen verwendet werden soll. Die von Azure Maps bereitgestellten einsatzbereiten Kacheln sind unten aufgeführt. Beispiel: microsoft.base.
| Wert | Beschreibung |
|---|---|
| microsoft.base |
Eine Basiskarte ist eine Standardkarte, die Straßen, natürliche und künstliche Features zusammen mit den Beschriftungen für diese Features in einer Vektorkachel anzeigt. Unterstützt Zoomstufen 0 bis 22. Format: Vektor (Pbf). |
| microsoft.base.labels |
Zeigt Beschriftungen für Straßen, natürliche und künstliche Merkmale in einer Vektorkachel an. Unterstützt Zoomstufen 0 bis 22. Format: Vektor (Pbf). |
| microsoft.base.hybrid |
Zeigt Straßen-, Begrenzungs- und Beschriftungsdaten in einer Vektorkachel an. Unterstützt Zoomstufen 0 bis 22. Format: Vektor (Pbf). |
| microsoft.terra.main |
Schattierte Relief- und Terraschichten. Unterstützt Zoomstufen 0 bis 6. Format: Raster (png). |
| microsoft.base.road |
Alle Ebenen mit unserem Hauptstil. Unterstützt Zoomstufen 0 bis 22. Format: Raster (png). |
| microsoft.base.darkgrey |
Alle Ebenen mit unserem dunkelgrauen Stil. Unterstützt Zoomstufen 0 bis 22. Format: Raster (png). |
| microsoft.base.labels.road |
Beschriftungsdaten in unserem Hauptstil. Unterstützt Zoomstufen 0 bis 22. Format: Raster (png). |
| microsoft.base.labels.darkgrey |
Beschriftungsdaten in unserer dunkelgrauen Formatvorlage. Unterstützt Zoomstufen 0 bis 22. Format: Raster (png). |
| microsoft.base.hybrid.road |
Straßen-, Begrenzungs- und Beschriftungsdaten in unserem Hauptstil. Unterstützt Zoomstufen 0 bis 22. Format: Raster (png). |
| microsoft.base.hybrid.darkgrey |
Straßen-, Begrenzungs- und Beschriftungsdaten in unserem dunkelgrauen Stil. Unterstützt Zoomstufen 0 bis 22. Format: Raster (png). |
| microsoft.imagery |
Eine Kombination aus Satelliten- oder Luftbildbildern. Nur in S1- und G2-Preis-SKU verfügbar. Unterstützt Zoomstufen 1 bis 19. Format: Raster (png). |
| microsoft.weather.radar.main |
Wetterradarkacheln. Aktuelle Wetterradarbilder wie Regen-, Schnee-, Eis- und Mischbedingungen. Weitere Informationen zur Abdeckung des Azure Maps-Wetterdiensts finden Sie unter Abdeckung der Azure Maps-Wetterdienste. Weitere Informationen zu Radardaten finden Sie unter Wetterdienste in Azure Maps. Unterstützt Zoomstufen 0 bis 15. Format: Raster (png). |
| microsoft.weather.infrared.main |
Wetter-Infrarot-Kacheln. Neueste Infrarotsatellitenbilder zeigen Wolken nach ihrer Temperatur. Weitere Informationen finden Sie unter Abdeckung der Azure Maps-Wetterdienste. Weitere Informationen zu den zurückgegebenen Satellitendaten finden Sie unter Wetterdienste in Azure Maps. Unterstützt Zoomstufen 0 bis 15. Format: Raster (png). |
| microsoft.traffic.absolute |
absolute Datenverkehrskacheln im Vektor |
| microsoft.traffic.absolute.main |
absolute Verkehrskacheln im Raster in unserem Hauptstil. |
| microsoft.traffic.relative |
Relative Datenverkehrskacheln im Vektor |
| microsoft.traffic.relative.main |
Relative Datenverkehrskacheln im Raster in unserem Hauptstil. |
| microsoft.traffic.relative.dark |
Relative Datenverkehrskacheln im Raster in unserem dunklen Stil. |
| microsoft.traffic.delay |
Datenverkehrskacheln im Vektor |
| microsoft.traffic.delay.main |
Verkehrskacheln im Raster in unserem Hauptstil |
| microsoft.traffic.reduced.main |
Reduzierte Verkehrskacheln im Raster im Hauptstil |
| microsoft.traffic.incident |
Vorfallkacheln im Vektor |