Sdílet prostřednictvím

Data Registry - Get Operation

  • Reference
Služba:
Maps
Verze rozhraní API:
2023-06-01

Slouží ke kontrole stavu registru dat 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 požadavek na nahrazení se vrátí v hlavičce registru nebo jako hodnota Operation-Location klíče. Zatímco probíhá, odpověď HTTP 200 OK se vrátí s Retry-After hlavičkou – po dokončení bude následovat http 200 OK bez další hlavičky.

Koncový bod služby registru dat je rozsahem omezený na oblast vašeho účtu Azure Maps a není dostupný 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
geography
 path True

string

Tento parametr určuje, kde se nachází účet Azure Maps. Platné hodnoty jsou us (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í stavu žádosti o registraci dat

Vzor regulárního výrazu: ^[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 služby Azure Maps.

Odpovědi

Name Typ Description
200 OK

LongRunningOperationResult

Stav dlouhotrvající operace.

Hlavičky

Retry-After: integer
Other Status Codes

MapsErrorResponse

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

Hlavičky

x-ms-error-code: string

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra 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 rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. 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 rozhraním REST API služby Azure Maps.

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í prostředku Azure Maps, 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 webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

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

Toto je 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 webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, tyto klíče se v současné době dají považovat za hlavní klíče k účtu, pro který jsou vystaveny.

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

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy 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

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
Retry-After: 10
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

Definice

Name Description
LongRunningOperationResult

Model odezvy pro dlouhotrvající operaci.
LongRunningOperationStatus

Stav dlouhotrvající operace.
MapsErrorDetail

Podrobnosti o chybě.
MapsErrorResponse

Běžná chybová odpověď pro rozhraní API služby 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 odezvy 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é sady kódů chyb.
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 služby 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.