Tileset - List
Dient zum Abrufen einer Liste von Kacheln.
Anmerkung
Azure Maps Creator-Einstellung
Der Azure Maps Creator-Indoor-Kartendienst ist jetzt veraltet und wird am 9.30.25. eingestellt. Weitere Informationen finden Sie unter Ankündigung zum Ende des Lebenszyklus von Azure Maps Creator.
Listenanforderung senden
Die List
-API ist eine HTTP-GET
Anforderung, die zum Abrufen einer Liste aller vorhandenen Kacheln verwendet wird.
GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
geography
|
path | True |
string |
Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind uns und eu. |
api-version
|
query | True |
string |
Versionsnummer der Azure Maps-API. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Kachelsatzanforderung wurde erfolgreich abgeschlossen. Der Antworttext enthält eine Liste aller Kacheln. |
|
Other Status Codes |
Unerwarteter Fehler. |
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.
Notizen
- 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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.
Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
query
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
Get a list of all tilesets
Beispielanforderung
GET https://us.atlas.microsoft.com/tilesets?api-version=2.0
Beispiel für eine Antwort
{
"tilesets": [
{
"tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84",
"datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b",
"description": "My first tileset",
"minZoom": 16,
"maxZoom": 18,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
},
{
"tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3",
"datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad",
"description": "My second tileset",
"minZoom": 19,
"maxZoom": 19,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
Error |
Fehlerantwort |
Tileset |
Detailinformationen für die Daten. |
Tileset |
Das Antwortmodell für die Kachellisten-API. Gibt eine Liste aller Kacheln zurück. |
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. |
Tileset
Detailinformationen für die Daten.
Name | Typ | Beschreibung |
---|---|---|
bbox |
number[] (double) |
Umgebendes Feld, in dem alle Features des Kachelsets liegen. Projektion verwendet - EPSG:3857. Format: 'minLon, minLat, maxLon, maxLat'. |
datasetId |
string |
Die eindeutige Dataset-ID, die zum Erstellen des Kachelsets verwendet wird. |
description |
string |
Die Beschreibung, die der Aufrufer beim Erstellen des Kachelsets bereitgestellt hat. Maximale Länge 1024 Zeichen. |
maxZoom |
integer |
Die Kachel mit der höchsten Kachelzoomebene, die für das Kachelset generiert wurde. |
minZoom |
integer |
Die Kachel mit der niedrigsten Kachelzoomebene, die für das Kachelset generiert wird. |
ontology |
string |
Die Ontologieversion dieses Datasets. |
tilesetId |
string |
Die eindeutige Kachel-ID für das Kachelset. |
TilesetListResult
Das Antwortmodell für die Kachellisten-API. Gibt eine Liste aller Kacheln zurück.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Wenn vorhanden, der Speicherort der nächsten Seite mit Daten. |
tilesets |
Tileset[] |
Eine Liste aller Kacheln. |