Conversion - Convert

Referencia

Szolgáltatás:: Maps Creator

API-verzió:: 2.0

Egy korábban importált rajzcsomag leképezési adatokká alakítása.

Az Conversion API egy HTTP-kérésPOST, amely lehetővé teszi a hívó számára, hogy tömörített rajzcsomagként importálja a DWG-tervfájlokat Azure Maps. A rajzcsomagra a udid data registrybe való feltöltéskor használt hivatkozás hivatkozik. További információ az adatregisztrációs adatbázis szolgáltatásról: Adatregisztrációs adatbázis létrehozása.

DWG-csomag konvertálása

A Conversion API hosszú ideig futó műveletet hajt végre.

DWG-csomagokkal kapcsolatos problémák hibakeresése

Az átalakítási folyamat során, ha bármilyen probléma merül fel a DWG-csomag hibáival kapcsolatban, a válaszban egy diagnosztikai csomag is szerepel, amely megjeleníti és diagnosztizálja ezeket a problémákat. Ha bármilyen probléma merül fel a DWG-csomaggal kapcsolatban, az itt ismertetett konvertálási művelet állapotfolyamata visszaadja a diagnosztikai csomag helyét, amelyet a hívó letölthet a problémák megjelenítéséhez és diagnosztizálásához. A diagnosztikai csomag helye a konvertálási művelet állapotválaszának tulajdonságok szakaszában található, és a következőképpen néz ki:

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

A diagnosztikai csomag egy kérés végrehajtásával HTTP GET tölthető le a diagnosticPackageLocationkövetkező webhelyen: . Az eszköz használatával az összes hiba és figyelmeztetés vizualizációjára és diagnosztizálására vonatkozó további részletekért lásd: Rajzi hiba vizualizációja.

A konvertálási művelet sikeresként lesz megjelölve, ha nulla vagy több figyelmeztetés van, de hiba esetén sikertelenként lesz megjelölve.

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

Opcionális paraméterekkel:

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

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 Létrehozó erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	A Azure Maps API verziószáma.
outputOntology	query	True	OutputOntology	Kimeneti ontológia verziója. A "facility-2.0" jelenleg az egyetlen támogatott érték. Ebben a cikkben talál további információt Azure Maps Alkotói teendőkről.
udid	query	True	string	A tartalom egyedi adatazonosítója (`udid`). Az Adatregisztrációs adatbázis létrehozásakor használtnak `udid` kell lennie.
description	query		string	A felhasználó megadta a konvertálandó tartalom leírását.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. A biztonsági Microsoft Entra ID Azure Maps az alábbi cikkekben talál útmutatást.

Válaszok

Name	Típus	Description
200 OK	LongRunningOperationResult	A művelet fut vagy befejeződött. Ha a művelet sikeres volt, a Resource-Location fejléc használatával szerezze be az eredmény elérési útját. Fejlécek Resource-Location: string
202 Accepted		Kérelem elfogadva: A kérelem feldolgozásra elfogadva. Az állapot lekéréséhez használja a Operation-Location fejlécében található URL-címet. Fejlécek Operation-Location: string
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Name

Típus

Description

200 OK

LongRunningOperationResult

A művelet fut vagy befejeződött. Ha a művelet sikeres volt, a Resource-Location fejléc használatával szerezze be az eredmény elérési útját.

Fejlécek

Resource-Location: string

202 Accepted

Kérelem elfogadva: A kérelem feldolgozásra elfogadva. Az állapot lekéréséhez használja a Operation-Location fejlécében található URL-címet.

Fejlécek

Operation-Location: string

Other Status Codes

ErrorResponse

Váratlan hiba történt.

Biztonság

AADToken

Ezek az OAuth 2.0-folyamatok Microsoft Entra. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. 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, a REST API-khoz Azure Maps engedélyekkel rendelkező 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ások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés 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 egy alkalmazás konfigurációalapú beállítását több használati esetben.

A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintés.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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 a PowerShell, a CLI, az Azure SDK-k vagy a 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ében azt javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével férhessen hozzá Azure Maps REST API-khoz, hogy a kulcs biztonságosan tárolható legyen.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre 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 jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

Convert previously uploaded DWG Package

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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"
}

Állapotkód:: 202

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

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
LongRunningOperationResult	A Long-Running Operations API válaszmodellje.
LroStatus	A kérelem állapotállapota.
OutputOntology	Kimeneti ontológia verziója. A "facility-2.0" jelenleg az egyetlen támogatott érték. Ebben a cikkben talál további információt Azure Maps Alkotói teendőkről.

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 információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

LongRunningOperationResult

A Long-Running Operations API válaszmodellje.

Name	Típus	Description
created	string	A létrehozott időbélyeg.
error	ErrorDetail	A hiba részletei.
operationId	string	A hosszú ideig futó művelet azonosítója.
status	LroStatus	A kérelem állapotállapota.
warning	ErrorDetail	A hiba részletei.

LroStatus

A kérelem állapotállapota.

Name	Típus	Description
Failed	string	A kérés egy vagy több hibával rendelkezik.
NotStarted	string	A kérés feldolgozása még nem kezdődött el.
Running	string	A kérés megkezdte a feldolgozást.
Succeeded	string	A kérés sikeresen befejeződött.

OutputOntology

Kimeneti ontológia verziója. A "facility-2.0" jelenleg az egyetlen támogatott érték. Ebben a cikkben talál további információt Azure Maps Alkotói teendőkről.

Name	Típus	Description
facility-2.0	string	A létesítmény ontológiája határozza meg, hogy Azure Maps létrehozó hogyan tárolja belsőleg a létesítményadatokat egy létrehozói adatkészletben.

Megosztás a következőn keresztül:

Conversion - Convert

DWG-csomag konvertálása

DWG-csomagokkal kapcsolatos problémák hibakeresése

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

AADToken

Jegyzetek

Hatókörök

subscription-key

SAS Token

Példák

Convert previously uploaded DWG Package

Mintakérelem

Mintaválasz

Definíciók

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

OutputOntology

További források