Style - Create
A használatával Azure Maps stílust hozhat létre.
Létrehozási kérelem elküldése
Az Style Create
API egy HTTP-kérésPOST
, amellyel Azure Maps stílust hozhat létre a stílusinformációkat tartalmazó JSON- vagy ZIP-fájl átadásával.
A Create Style API egy hosszú ideig futó művelet.
POST https://{geography}.atlas.microsoft.com/styles?api-version=2023-03-01-preview
POST https://{geography}.atlas.microsoft.com/styles?api-version=2023-03-01-preview&description={description}&alias={alias}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Ez a paraméter határozza meg, hogy hol található a Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu. |
api-version
|
query | True |
string |
Azure Maps API verziószáma. |
alias
|
query |
string |
A stílus aliasa. Maximális hossz 1024 karakter. Az alias nem kezdődhet fenntartott előtaggal |
|
description
|
query |
string |
A felhasználó megadta a stílus leírását. Maximális hossz 1024 karakter. |
Kérelem fejléce
Media Types: "application/json", "application/zip"
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-id |
string |
Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást. |
Kérelem törzse
Media Types: "application/json", "application/zip"
Name | Típus | Description |
---|---|---|
CreateContent |
object |
A feltöltendő stílustartalom. Ha A JSON-adatformátum meg van adva, akkor a kérelem törzsének a MapLibre Style specifikációjának Rétegek specifikációját kell követnie. Ha ZIP-adatformátum van megadva, meg kell adnia a sprite lapot és a társított indexfájlokat is, amelyek a stíluskonfigurációs json-fájlban használt ikonokat tartalmazzák. |
Válaszok
Name | Típus | Description |
---|---|---|
202 Accepted |
Kérelem elfogadva: A kérelem feldolgozásra el lett fogadva. Az állapot lekéréséhez használja a Operation-Location fejlécben található URL-címet. Headers Operation-Location: string |
|
Other Status Codes |
Váratlan hiba történt. |
Biztonság
AADToken
Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.
A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.
Jegyzetek
- Ez a biztonsági definíció megköveteli a fejléc használatát annak
x-ms-client-id
jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.
A Authorization URL
az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek.
* Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
* A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.
- Az Azure Active Directory 1.0-s vagy 2.0-s verziója jelenleg a munkahelyi, iskolai és vendégfelhasználói fiókokat támogatja, de nem támogatja a személyes fiókokat.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy PowerShell, CLI, Azure SDK vagy REST API használatával.
Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.
Nyilvánosan közzétett alkalmazások esetén javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.
Type:
apiKey
In:
query
SAS Token
Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.
Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.
Type:
apiKey
In:
header
Példák
Create Style by providing an azure maps style json file
Sample Request
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
}
}
]
}
Sample Response
Operation-Location: https://us.atlas.microsoft.com/styles/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location
Definíciók
Name | Description |
---|---|
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további adattípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hiba célja. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |