Style - Create
Slouží k vytvoření stylu Azure Maps.
Odeslat žádost o vytvoření
Rozhraní Style Create
API je požadavek HTTPPOST
, který se používá k vytvoření Azure Maps stylu předáním souboru JSON nebo ZIP obsahujícího informace o stylu.
Rozhraní API pro vytvoření stylu je dlouhotrvající operace.
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}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Tento parametr určuje, kde se nachází prostředek Azure Maps Creator. Platné hodnoty jsou my a eu. |
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
alias
|
query |
string |
Alias stylu. Maximální délka je 1024 znaků. Alias nemůže začínat |
|
description
|
query |
string |
Uživatel zadal popis stylu. Maximální délka je 1024 znaků. |
Hlavička požadavku
Media Types: "application/json", "application/zip"
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Text požadavku
Media Types: "application/json", "application/zip"
Name | Typ | Description |
---|---|---|
CreateContent |
object |
Styl obsahu, který se má nahrát. Pokud je k dispozici formát dat JSON, měl by text požadavku odpovídat specifikaci vrstev ve specifikaci stylu MapLibre. Pokud je k dispozici datový formát ZIP, měli byste také zadat list spritu a přidružené indexové soubory, které obsahují ikony použité v souboru JSON konfigurace stylu. |
Odpovědi
Name | Typ | Description |
---|---|---|
202 Accepted |
Žádost byla přijata: Žádost byla přijata ke zpracování. K získání stavu použijte adresu URL v hlavičce Operation-Location. Headers Operation-Location: string |
|
Other Status Codes |
Došlo k neočekávané chybě. |
Zabezpečení
AADToken
Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Azure Active Directory verze 1.0 nebo 2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.
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
Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.
U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.
Type:
apiKey
In:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Type:
apiKey
In:
header
Příklady
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
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |