Conversion - Get Operation

Reference

Service:: Maps Creator

API Version:: 2.0

Slouží ke kontrole stavu procesu převodu.

Rozhraní Get Operation API je požadavek HTTP GET , který volajícímu umožňuje zkontrolovat stav procesu převoduconversionId a načíst hodnotu.

Tato cesta bude získána z volání POST /conversions. V průběhu se vrátí kód odpovědi HTTP 200 bez dalších hlaviček a po úspěšném dokončení bude následovat kód odpovědi HTTP 200 s hlavičkou Resource-Location .

GET https://{geography}.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0

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.
operationId	path	True	string	ID pro dotaz na stav žádosti o vytvoření nebo import převodu.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.

Odpovědi

Name	Typ	Description
200 OK	LongRunningOperationResult	Operace je spuštěná nebo dokončená. Pokud byla operace úspěšná, získejte cestu k výsledku pomocí hlavičky Resource-Location. Headers Resource-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á, získejte cestu k výsledku pomocí hlavičky Resource-Location.

Headers

Resource-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 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 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.

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

Get the status of an operation which has finished successfully, with non-fatal warnings

Get the status of an operation which is still running

Get the status of an operation which has finished successfully, with non-fatal warnings

Sample Request

HTTP

GET https://us.atlas.microsoft.com/conversions/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample Response

Status code:: 200

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

Response Body

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded",
  "warning": {
    "code": "dwgConversionProblem",
    "details": [
      {
        "code": "warning",
        "details": [
          {
            "code": "manifestWarning",
            "message": "Ignoring unexpected JSON property: unitProperties[0].nonWheelchairAccessible with value False"
          }
        ]
      }
    ]
  }
}

Get the status of an operation which is still running

Sample Request

HTTP

GET https://us.atlas.microsoft.com/conversions/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample Response

Status code:: 200

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
LongRunningOperationResult	Model odpovědí pro rozhraní API Long-Running Operations.
LroStatus	Stav požadavku.

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	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

Chybová odpověď

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	Požadavek se začal zpracovávat.
Succeeded	string	Žádost byla úspěšně dokončena.

Share via

Conversion - Get Operation

Parametry identifikátoru URI

Odpovědi

Zabezpečení

AADToken

Poznámky

Scopes

subscription-key

SAS Token

Příklady

Get the status of an operation which has finished successfully, with non-fatal warnings

Sample Request

Sample Response

Get the status of an operation which is still running

Sample Request

Sample Response

Definice

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Další materiály