Conversion - Convert

Reference

Služba:: Maps Creator

Verze rozhraní API:: 2.0

Slouží k převodu dříve importovaného balíčku kreslení na mapová data.

Rozhraní Conversion API je požadavek HTTPPOST, který volajícímu umožňuje importovat sadu souborů návrhu DWG jako komprimovaný balíček výkresu do Azure Maps. Na balíček výkresu udid odkazuje použitý při nahrání do registru dat. Další informace o službě registru dat najdete v tématu Vytvoření registru dat.

Převést balíček DWG

Rozhraní API pro převod provádí dlouhotrvající operaci.

Ladění problémů s balíčkem DWG

Pokud během procesu převodu dojde k nějakým problémům s chybami balíčku DWG, zobrazí se v odpovědi společně s diagnostickým balíčkem , který tyto problémy vizualizuje a diagnostikuje. V případě jakýchkoli problémů s balíčkem DWG vrátí proces stavu operace převodu, který je zde podrobně popsán, umístění diagnostického balíčku , který si může volající stáhnout, aby jim pomohl tyto problémy vizualizovat a diagnostikovat. Umístění diagnostického balíčku najdete v části vlastnosti v odpovědi na stav operace převodu a vypadá takto:

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

Diagnostický balíček lze stáhnout spuštěním HTTP GET požadavku na diagnosticPackageLocation. Další podrobnosti o tom, jak pomocí nástroje vizualizovat a diagnostikovat všechny chyby a upozornění, najdete v tématu Vizualizér chyb výkresu.

Pokud se zobrazí nula nebo více upozornění, operace převodu se označí jako úspěšná , ale pokud dojde k nějakým chybám, označí se jako neúspěšná .

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0

S volitelnými parametry:

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0&description={description}

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.
outputOntology	query	True	OutputOntology	Verze výstupní ontologie. "facility-2.0" je v tuto chvíli jedinou podporovanou hodnotou. Další informace o ontologiích Azure Maps Creator najdete v tomto článku.
udid	query	True	string	Jedinečné ID dat (`udid`) pro obsah. Musí se použít při `udid` vytváření registru dat.
description	query		string	Uživatel zadal popis převáděného obsahu.

Hlavička požadavku

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 dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	LongRunningOperationResult	Operace je spuštěná nebo dokončená. Pokud byla operace úspěšná, použijte k získání cesty k výsledku hlavičku Resource-Location. Hlavičky Resource-Location: string
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. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Name

Typ

Description

200 OK

LongRunningOperationResult

Operace je spuštěná nebo dokončená. Pokud byla operace úspěšná, použijte k získání cesty k výsledku hlavičku Resource-Location.

Hlavičky

Resource-Location: string

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.

Hlavičky

Operation-Location: string

Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. 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, která se skládá 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 k určitým rozhraním API a oborům.

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. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Ří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í.

Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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á každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps 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 oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnější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 mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

Convert previously uploaded DWG Package

Ukázkový požadavek

HTTP

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Ukázková odpověď

Stavový kód:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Stavový kód:: 202

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
LongRunningOperationResult	Model odpovědí pro rozhraní API Long-Running Operations.
LroStatus	Stav požadavku.
OutputOntology	Verze výstupní ontologie. "facility-2.0" je v tuto chvíli jedinou podporovanou hodnotou. Další informace o ontologiích Azure Maps Creator najdete v tomto článku.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LongRunningOperationResult

Model odpovědí pro rozhraní API Long-Running Operations.

Name	Typ	Description
created	string	Vytvořené časové razítko.
error	ErrorDetail	Podrobnosti o chybě.
operationId	string	ID této dlouhotrvající operace.
status	LroStatus	Stav požadavku.
warning	ErrorDetail	Podrobnosti o chybě.

LroStatus

Stav požadavku.

Name	Typ	Description
Failed	string	Požadavek má jedno nebo více selhání.
NotStarted	string	Žádost se ještě nezačala zpracovávat.
Running	string	Žádost se začala zpracovávat.
Succeeded	string	Žádost se úspěšně dokončila.

OutputOntology

Verze výstupní ontologie. "facility-2.0" je v tuto chvíli jedinou podporovanou hodnotou. Další informace o ontologiích Azure Maps Creator najdete v tomto článku.

Name	Typ	Description
facility-2.0	string	Ontologie zařízení definuje, jak Azure Maps Creator interně ukládá data zařízení do datové sady Creator.

Sdílet prostřednictvím

Conversion - Convert

Převést balíček DWG

Ladění problémů s balíčkem DWG

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

AADToken

Poznámky

Rozsahy

subscription-key

SAS Token

Příklady

Convert previously uploaded DWG Package

Ukázkový požadavek

Ukázková odpověď

Definice

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

OutputOntology

Další materiály