Data Registry - Get Operation

Referens

Tjänst:: Maps

API-version:: 2023-06-01

Använd för att kontrollera status för dataregistret eller ersätta begäran.
API:et Get Operation är en HTTP-begäran GET som används för att hämta status för ett dataregister eller ersätta begäran returneras i rubriken för registret eller ersätta svaret som värdet för Operation-Location nyckeln. Under tiden returneras ett HTTP-svar 200 OK med Retry-After sidhuvud – följt av en HTTP 200 OK utan extra rubrik när den har slutförts.

Tjänstslutpunkten för dataregistret är begränsad i omfånget till regionen för ditt Azure Maps-konto och är inte tillgänglig för globala Azure Maps-konton.

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

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
geography	path	True	string	Den här parametern anger var Azure Maps-kontot finns. Giltiga värden är oss (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra).
operationId	path	True	string	Det ID som används för att fråga efter status för en dataregisterbegäran. Reguljärt uttrycksmönster: `^[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	Versionsnumret för Azure Maps API.

geography

path

True

string

Den här parametern anger var Azure Maps-kontot finns. Giltiga värden är oss (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra).

operationId

path

True

string

Det ID som används för att fråga efter status för en dataregisterbegäran.

Reguljärt uttrycksmönster: ^[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

Versionsnumret för Azure Maps API.

Svar

Name	Typ	Description
200 OK	LongRunningOperationResult	Status för den långvariga åtgärden. Sidhuvuden Retry-After: integer
Other Status Codes	MapsErrorResponse	Det uppstod ett oväntat fel. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

LongRunningOperationResult

Status för den långvariga åtgärden.

Sidhuvuden

Retry-After: integer

Other Status Codes

MapsErrorResponse

Det uppstod ett oväntat fel.

Sidhuvuden

x-ms-error-code: string

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 REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton 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 till Rest-API:er för Azure Maps.

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 få å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 programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

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

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

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 en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de utfärdas för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst till Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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 mer säkert 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 återgivningsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

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

Exempelbegäran

HTTP

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

Exempelsvar

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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Get the status of an operation that is still running

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

Retry-After: 10

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

Definitioner

Name	Description
LongRunningOperationResult	Svarsmodellen för en långvarig åtgärd.
LongRunningOperationStatus	Status för en långvarig åtgärd.
MapsErrorDetail	Felinformationen.
MapsErrorResponse	Vanliga felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder.
MapsInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

LongRunningOperationResult

Svarsmodellen för en långvarig åtgärd.

Name	Typ	Description
error	MapsErrorDetail	Felinformationen.
id	string	OperationId
status	LongRunningOperationStatus	Status för en långvarig åtgärd.

LongRunningOperationStatus

Status för en långvarig åtgärd.

Name	Typ	Description
Completed	string	Begäran har slutförts.
Failed	string	Begäran har ett eller flera fel.
Running	string	Begäran bearbetas för närvarande.

MapsErrorDetail

Felinformationen.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	MapsErrorDetail[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	MapsInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

MapsErrorResponse

Vanliga felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder.

Name	Typ	Description
error	MapsErrorDetail	Felinformationen.

MapsInnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Name	Typ	Description
code	string	Felkoden.
innererror	MapsInnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Dela via

Data Registry - Get Operation

URI-parametrar

Svar

Säkerhet

AADToken

Kommentarer

Omfattningar

subscription-key

SAS Token

Exempel

Get the status of an operation that failed

Exempelbegäran

Exempelsvar

Get the status of an operation that finished successfully

Exempelbegäran

Exempelsvar

Get the status of an operation that is still running

Exempelbegäran

Exempelsvar

Definitioner

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Ytterligare resurser