Conversion - Convert

Referens

Tjänst:: Maps Creator

API-version:: 2.0

Använd för att konvertera ett tidigare importerat ritpaket till kartdata.

API:et Conversion är en HTTP-begäran POST som gör att anroparen kan importera en uppsättning DWG-designfiler som ett zippat ritpaket till Azure Maps. Ritningspaketet refereras av det udid som användes när det laddades upp till dataregistret. Mer information om dataregistertjänsten finns i Så här skapar du dataregister.

Konvertera DWG-paket

Konverterings-API:et utför en tidskrävande åtgärd.

Felsöka problem med DWG-paket

Om det finns problem med DWG-paketfelen och varningarna under konverteringsprocessen anges i svaret tillsammans med ett diagnostikpaket för att visualisera och diagnostisera dessa problem. Om det uppstår problem med DWG-paketet returnerar statusprocessen för konverteringsåtgärden enligt beskrivningen här platsen för diagnostikpaketet som kan laddas ned av anroparen för att hjälpa dem att visualisera och diagnostisera dessa problem. Platsen för diagnostikpaketet finns i egenskapsavsnittet i statussvaret för konverteringsåtgärden och ser ut så här:

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

Diagnostikpaketet kan laddas ned genom att köra en HTTP GET begäran på diagnosticPackageLocation. Mer information om hur du använder verktyget för att visualisera och diagnostisera alla fel och varningar finns i Visualiseraren för ritfel.

En konverteringsåtgärd markeras som lyckad om det finns noll eller fler varningar, men markeras som misslyckad om några fel påträffas.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
geography	path	True	string	Den här parametern anger var Azure Maps Creator-resursen finns. Giltiga värden är vi och eu.
api-version	query	True	string	Versionsnummer för Azure Maps API.
outputOntology	query	True	OutputOntology	Utdata ontologiversion. "facility-2.0" är det enda värde som stöds just nu. Mer information om Azure Maps Creator-ontologier finns i den här artikeln.
udid	query	True	string	Det unika data-ID:t (`udid`) för innehållet. Måste vara samma `udid` som när du skapar dataregistret.
description	query		string	Användaren har angett en beskrivning av innehållet som konverteras.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name	Typ	Description
200 OK	LongRunningOperationResult	Åtgärden körs eller slutförs. Om åtgärden lyckades använder du Resource-Location-huvudet för att hämta sökvägen till resultatet. Sidhuvuden Resource-Location: string
202 Accepted		Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i Operation-Location-rubriken för att hämta status. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Name

Typ

Description

200 OK

LongRunningOperationResult

Åtgärden körs eller slutförs. Om åtgärden lyckades använder du Resource-Location-huvudet för att hämta sökvägen till resultatet.

Sidhuvuden

Resource-Location: string

202 Accepted

Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i Operation-Location-rubriken för att hämta status.

Sidhuvuden

Operation-Location: string

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Convert previously uploaded DWG Package

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
}

Statuskod:: 202

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

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
LongRunningOperationResult	Svarsmodellen för ett Long-Running Operations API.
LroStatus	Statustillståndet för begäran.
OutputOntology	Utdata ontologiversion. "facility-2.0" är det enda värde som stöds just nu. Mer information om Azure Maps Creator-ontologier finns i den här artikeln.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

LongRunningOperationResult

Svarsmodellen för ett Long-Running Operations API.

Name	Typ	Description
created	string	Den skapade tidsstämpeln.
error	ErrorDetail	Felinformationen.
operationId	string	ID:t för den här långvariga åtgärden.
status	LroStatus	Statustillståndet för begäran.
warning	ErrorDetail	Felinformationen.

LroStatus

Statustillståndet för begäran.

Name	Typ	Description
Failed	string	Begäran har ett eller flera fel.
NotStarted	string	Begäran har inte börjat bearbetas än.
Running	string	Begäran har börjat bearbetas.
Succeeded	string	Begäran har slutförts.

OutputOntology

Utdata ontologiversion. "facility-2.0" är det enda värde som stöds just nu. Mer information om Azure Maps Creator-ontologier finns i den här artikeln.

Name	Typ	Description
facility-2.0	string	Anläggningsontologi definierar hur Azure Maps Creator internt lagrar anläggningsdata i en Creator-datauppsättning.

Dela via

Conversion - Convert

Konvertera DWG-paket

Felsöka problem med DWG-paket

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Kommentarer

Omfattningar

subscription-key

SAS Token

Exempel

Convert previously uploaded DWG Package

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

OutputOntology

Ytterligare resurser