Tileset - Get Operation

Service:

Maps Creator

API Version:

2.0

A használatával lekérheti a csempekészletek létrehozásának állapotát.

Az Get Operation API egy HTTP-kérés GET , amellyel ellenőrizheti a csempék létrehozási folyamatának állapotát, és lekérheti az tilesetId értéket. Az elérési út a Tileset – Létrehozás hívásából lesz lekérve. Amíg folyamatban van, a http 200-ak további fejlécek nélkül lesznek visszaadva. Miután sikeresen befejeződött, a HTTP 200 egy fejléccel Resource-Location lesz visszaadva. További információ: Csempekészlet-létrehozás állapotának ellenőrzése.

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

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.
operationId	path	True	string	A csempekészlet létrehozási/importálási kérésének állapotának lekérdezéséhez használt azonosító.
api-version	query	True	string	A Azure Maps API verziószáma.

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

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

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.

Type: 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.

Type: apiKey
In: header

Példák

Get the status of an operation which has finished successfully

Get the status of an operation which is still running

Get the status of an operation which has finished successfully

Sample Request

HTTP

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

Sample Response

Status code:

200

Resource-Location: https://us.atlas.microsoft.com/tilesets/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"
}

Get the status of an operation which is still running

Sample Request

HTTP

GET https://us.atlas.microsoft.com/tilesets/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"
}

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.

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.