Map Configuration - Create

Referenz

Dienst:: Maps Creator

API-Version:: 2023-03-01-preview

Verwenden Sie , um eine Zuordnungskonfiguration zu erstellen.

Weitere Informationen dazu, was eine Kartenkonfiguration ist, finden Sie im Artikel Creator für Raumkartenkonzepte .

Übermitteln der Erstellungsanforderung

Die Kartenkonfigurations-API Create ist eine HTTP-Anforderung POST , die zum Erstellen einer neuen Kartenkonfiguration verwendet wird.

POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview

Mit optionalen Parametern:

POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias={alias}&description={description}

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 "us" und "eu".
api-version	query	True	string	Versionsnummer der Azure Maps API.
alias	query		string	Der Alias der Zuordnungskonfiguration. Maximale Länge von 1024 Zeichen. Der Alias kann nicht mit `microsoft-maps` einem reservierten Präfix beginnen. Der Alias kann optional beim Erstellen einer Zuordnungskonfiguration bereitgestellt werden und kann nach der Erstellung der Kartenkonfiguration mit mapConfigurationId verwendet werden.
description	query		string	Vom Benutzer bereitgestellte Beschreibung der Kartenkonfiguration. Maximale Länge von 1024 Zeichen.

Anforderungsheader

Media Types: "application/json", "application/zip"

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Anforderungstext

Media Types: "application/json", "application/zip"

Name	Erforderlich	Typ	Beschreibung
version	True	number	Die Version der Kartenkonfiguration, derzeit nur Version 1.0, wird unterstützt.
configurations		ConfigurationObject[]	Das Array "Konfigurationen" ermöglicht es dem Kunden, verschiedene Kartendarstellungen für sein Kachelset zu konfigurieren. Jede hier konfigurierte Konfiguration wird als ein Kartenformat in der Stilauswahl im Client-SDK widerspiegelt. Der Name sollte im Konfigurationsarray eindeutig sein.
defaultConfiguration		string	Die Standardkonfiguration für die Kartenkonfiguration. Der Wert sollte eines des Felds "name" in ConfigurationObject unter dem Array "configurations" sein. Falls nicht angegeben, wird der erste Eintrag in der Liste "Konfigurationen" verwendet.
description		string	Die Beschreibung, die der Aufrufer beim Erstellen der Kartenkonfiguration bereitgestellt hat. Maximale Länge von 1024 Zeichen.

Antworten

Name	Typ	Beschreibung
202 Accepted		Anforderung akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert. Verwenden Sie die URL im Operation-Location-Header, um status zu erhalten. Header Operation-Location: string
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Name

Typ

Beschreibung

202 Accepted

Anforderung akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert. Verwenden Sie die URL im Operation-Location-Header, um status zu erhalten.

Header

Operation-Location: string

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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 Kartenverwaltungs-API abgerufen werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über 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.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeit, Schule und Gäste, aber keine persönlichen Konten.

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 verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen 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 Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Create a map configuration by providing a configuration file

Beispielanforderung

HTTP

POST https://us.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias=sample-alias&description=This is my first map configuration.

{
  "version": 1,
  "description": "This is Microsoft default indoor map configuration",
  "defaultConfiguration": "microsoft_light",
  "configurations": [
    {
      "name": "indoor_light",
      "displayName": "Indoor light",
      "description": "A base style for Azure Maps.",
      "theme": "light",
      "baseMap": "microsoft_light",
      "layers": [
        {
          "tilesetId": "{tilesetId}",
          "styleId": "microsoft-maps:indoor_2022-01-01"
        }
      ]
    },
    {
      "name": "indoor_dark",
      "displayName": "Indoor dark",
      "description": "A base style for Azure Maps.",
      "theme": "dark",
      "baseMap": "microsoft_dark",
      "layers": [
        {
          "tilesetId": "{tilesetId}",
          "styleId": "microsoft-maps:indoor_dark_2022-01-01"
        }
      ]
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 202

Operation-Location: https://us.atlas.microsoft.com/styles/mapConfigurations/operations/{operationId}?api-version=2022-01-01-preview
Access-Control-Expose-Headers: Operation-Location

Definitionen

Name	Beschreibung
BaseMap	Die Basiskarte ist eine Hintergrundebene für eine private Innenkarte. Diese Eigenschaft ist optional. Wenn nicht angegeben, wird keine Basiskarte angezeigt. Maximale Länge 100 Zeichen.
ConfigurationObject	Definieren Sie das Format, um eine Stilauswahl und die zugeordnete Zuordnung im Client-SDK zu konfigurieren.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
MapConfiguration	Ein Kartenkonfigurationsobjekt, das das JSON-Format der Kartenkonfiguration beschreibt.
theme	Das Design für Client-SDK-Widgets (Stilauswahl, Zoom, Ebenenauswahl).
TilesetStyleTuple	TilesetId und StyleId Tupel

BaseMap

Die Basiskarte ist eine Hintergrundebene für eine private Innenkarte. Diese Eigenschaft ist optional. Wenn nicht angegeben, wird keine Basiskarte angezeigt. Maximale Länge 100 Zeichen.

Name	Typ	Beschreibung
microsoft_dark	string	Das Basisformat der dunklen Straßenkarte.
microsoft_grayscale_dark	string	Das graustufend dunkle Kartenformat.
microsoft_grayscale_light	string	Die Graustufen-Lightmap-Formatvorlage.
microsoft_high_contrast_dark	string	Die dunkle Kartenformatvorlage mit hohem Kontrast.
microsoft_high_contrast_light	string	Das Lichtkartenformat mit hohem Kontrast.
microsoft_light	string	Der Grundlegende Straßenkartenstil.
microsoft_satellite	string	Der Kartenstil für Satellitenbilder.
microsoft_satellite_road	string	Der Satelliten- und Straßenkartenstil.
microsoft_shaded_relief	string	Das Schattierte Relief-Kartenformat.

ConfigurationObject

Definieren Sie das Format, um eine Stilauswahl und die zugeordnete Zuordnung im Client-SDK zu konfigurieren.

Name	Typ	Beschreibung
baseMap	BaseMap	Die Basiskarte ist eine Hintergrundebene für eine private Innenkarte. Diese Eigenschaft ist optional. Wenn nicht angegeben, wird keine Basiskarte angezeigt. Maximale Länge 100 Zeichen.
description	string	Die Beschreibung für den Stil. Maximale Länge 500 Zeichen.
displayName	string	Der Anzeigename für die Stilauswahl im Client-SDK. Maximale Länge 255 Zeichen.
layers	TilesetStyleTuple[]	So konfigurieren Sie den Stil für das Kachelset. Sie können eine Formatvorlage für das gesamte Kachelset verwenden. Und Sie können unterschiedliche Stile für verschiedene Ebenen in einem Kachelset haben, z. B. eine Formatvorlage für `indoor unit` ebene und eine andere für ebene `indoor facility` . Und Sie haben auch einen Stil für verschiedene Kachelsets.
name	string	Der Name für die Formatvorlage. Maximale Länge 255 Zeichen.
theme	theme	Das Design für Client-SDK-Widgets (Stilauswahl, Zoom, Ebenenauswahl).
thumbnail	string	Die Miniaturansichtsbilddatei für die Formatauswahl im Client-SDK. Maximale Länge 255 Zeichen. Die Größenbeschränkung beträgt 400 KB und die Pixelbegrenzung 512 * 512.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.