Style - Create

Referenz

Dienst:: Maps Creator

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

Verwenden Sie, um einen Azure Maps Stil zu erstellen.

Erstellen einer Anforderung übermitteln

Die Style Create API ist eine HTTP-AnforderungPOST, die zum Erstellen eines Azure Maps Stils verwendet wird, indem entweder eine JSON- oder ZIP-Datei übergeben wird, die die Formatinformationen enthält.

Die Create Style-API ist ein Vorgang mit langer Ausführungsdauer.

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

Mit optionalen Parametern:

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

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 wir und eu.
api-version	query	True	string	Versionsnummer der Azure Maps API.
alias	query		string	Der Alias des Stils. Maximale Länge von 1024 Zeichen. Alias kann nicht mit einem reservierten `microsoft-maps` Präfix beginnen. Alias kann optional beim Erstellen einer Formatvorlage bereitgestellt werden und kann nach der Formaterstellung wie styleId verwendet werden.
description	query		string	Vom Benutzer bereitgestellte Beschreibung des Stils. 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 für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Anforderungstext

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

Name	Typ	Beschreibung
CreateContent	object	Der Formatinhalt, der hochgeladen werden soll. Wenn das JSON-Datenformat bereitgestellt wird, sollte der Anforderungstext die Layer-Spezifikation in der MapLibre Style-Spezifikation befolgen. Wenn das ZIP-Datenformat bereitgestellt wird, sollten Sie auch das Sprite-Blatt und die zugehörigen Indexdateien bereitstellen, die Symbole enthalten, die in der JSON-Datei für die Formatkonfiguration verwendet werden.

Antworten

Name	Typ	Beschreibung
202 Accepted		Anforderung akzeptiert: Die Anforderung wurde zur 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 zur 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. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in 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 Work, School und Guests, 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 genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, 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 zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Create Style by providing an azure maps style json file

Beispielanforderung

HTTP

POST https://us.atlas.microsoft.com/styles?api-version=2023-03-01-preview&alias=test-alias

{
  "layers": [
    {
      "id": "background",
      "type": "background",
      "source-layer": "bg-source",
      "minzoom": 18,
      "maxzoom": 20,
      "layout": {
        "visibility": "none",
        "symbol-placement": "point",
        "symbol-avoid-edges": true,
        "text-field": "{name}",
        "text-keep-upright": true,
        "text-font": [
          "SegoeUi-SemiBold"
        ],
        "text-letter-spacing": 0.1,
        "text-size": {
          "stops": [
            [
              18.5,
              6.5
            ],
            [
              19,
              8
            ],
            [
              19.5,
              9.5
            ],
            [
              20,
              11
            ]
          ]
        },
        "text-anchor": "center"
      },
      "paint": {
        "text-color": "rgb(0, 0, 0)",
        "text-halo-color": "rgb(255, 255, 255)",
        "text-halo-width": 1,
        "text-halo-blur": 0.5
      }
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 202

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort

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.

Freigeben über

Style - Create

Erstellen einer Anforderung übermitteln

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

Create Style by providing an azure maps style json file

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Zusätzliche Ressourcen