Data Registry - Get Operation

Reference

Service:: Maps

API Version:: 2023-06-01

Pomocí příkazu zkontrolujte stav datového registru nebo žádosti o nahrazení.
Rozhraní Get Operation API je požadavek HTTP GET , který se používá k získání stavu registru dat nebo k požadavku na nahrazení, který se vrátí v hlavičce odpovědi register nebo replace jako hodnota Operation-Location klíče. V průběhu se vrátí odpověď HTTP 200 OK s Retry-After hlavičkou následovanou http 200 OK bez další hlavičky po dokončení.

Rozsah koncového bodu služby registru dat je omezený na oblast vašeho účtu Azure Maps a není k dispozici pro globální účty Azure Maps.

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
geography	path	True	string	Tento parametr určuje, kde se nachází účet Azure Maps. Platné hodnoty jsou my (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa).
operationId	path	True	string	ID použité k dotazování na stav žádosti o registraci dat. Regex pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.

geography

path

True

string

Tento parametr určuje, kde se nachází účet Azure Maps. Platné hodnoty jsou my (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa).

operationId

path

True

string

ID použité k dotazování na stav žádosti o registraci dat.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

api-version

query

True

string

Číslo verze rozhraní API Azure Maps.

Odpovědi

Name	Typ	Description
200 OK	LongRunningOperationResult	Stav dlouhotrvající operace. Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	Došlo k neočekávané chybě. Headers x-ms-error-code: string

Name

Typ

Description

200 OK

LongRunningOperationResult

Stav dlouhotrvající operace.

Headers

Retry-After: integer

Other Status Codes

MapsErrorResponse

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

Headers

x-ms-error-code: string

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řizuje při vytváření 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 klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.

U veřejně vystavených aplikací doporučujeme použít přístup mezi servery Azure Maps rozhraní REST API, kde je možné tento klíč bezpečně uložit.

Type: apiKey
In: header

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

Get the status of an operation that finished successfully

Get the status of an operation that is still running

Get the status of an operation that failed

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

Retry-After: 10

Response Body

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

Definice

Name	Description
LongRunningOperationResult	Model odpovědi pro dlouhotrvající operaci.
LongRunningOperationStatus	Stav dlouhotrvající operace.
MapsErrorDetail	Podrobnosti o chybě
MapsErrorResponse	Běžná chybová odpověď pro rozhraní API Azure Maps, která vrací podrobnosti o chybě pro neúspěšné operace.
MapsInnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

LongRunningOperationResult

Model odpovědi pro dlouhotrvající operaci.

Name	Typ	Description
error	MapsErrorDetail	Podrobnosti o chybě
id	string	Id operace
status	LongRunningOperationStatus	Stav dlouhotrvající operace.

LongRunningOperationStatus

Stav dlouhotrvající operace.

Name	Typ	Description
Completed	string	Požadavek se úspěšně dokončil.
Failed	string	Požadavek má jedno nebo více selhání.
Running	string	Žádost se právě zpracovává.

MapsErrorDetail

Podrobnosti o chybě

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	MapsErrorDetail[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	MapsInnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

MapsErrorResponse

Běžná chybová odpověď pro rozhraní API Azure Maps, která vrací podrobnosti o chybě pro neúspěšné operace.

Name	Typ	Description
error	MapsErrorDetail	Podrobnosti o chybě

MapsInnerError

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

Name	Typ	Description
code	string	Kód chyby
innererror	MapsInnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

Data Registry - 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 that failed

Sample Request

Sample Response

Get the status of an operation that finished successfully

Sample Request

Sample Response

Get the status of an operation that is still running

Sample Request

Sample Response

Definice

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Další materiály