Data - Get Operation
Använd för att kontrollera statusen för en datauppladdningsbegäran och hämta värdet när det udid
har slutförts.
Anteckning
Azure Maps Data Service-tillbakadragning
Den Azure Maps datatjänsten (både v1 och v2) är nu inaktuell och kommer att dras tillbaka den 24-09-16. För att undvika avbrott i tjänsten måste alla anrop till datatjänsten uppdateras för att använda Azure Maps Data Registry-tjänsten senast 24-09-16. Mer information finns i Skapa dataregister.
API:et Get Operation
är en HTTP-begäran GET
som gör att anroparen kan kontrollera statusen för en datauppladdningsåtgärd och hämta värdet när det udid
har slutförts. Den här sökvägen hämtas från ett anrop till POST /mapData. Under tiden returneras en HTTP 200-svarskod utan extra rubriker , följt av en HTTP 200-svarskod med en Resource-Location
rubrik när den har slutförts.
Viktigt
Genom att använda den här funktionen godkänner du de juridiska villkoren för förhandsversionen. Mer information finns i Tilläggsvillkor för förhandsversion .
GET https://{geography}.atlas.microsoft.com/mapData/operations/{operationId}?api-version=2.0
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Den här parametern anger var Azure Maps Creator-resursen finns. Giltiga värden är vi och eu. |
operation
|
path | True |
string |
ID:t för att fråga status för datauppladdningsbegäran. |
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Åtgärden körs eller slutförs. Om åtgärden lyckades använder du Resource-Location-huvudet för att hämta sökvägen till resultatet. Headers Resource-Location: string |
|
Other Status Codes |
Det uppstod ett oväntat fel. |
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 Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto 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 för att Azure Maps REST-API:er.
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 ha åtkomstkontroll för specifika API:er och omfång.
Kommentarer
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer.
* Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.
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
Det här är en delad nyckel som etableras när du Skapa ett Azure Maps konto i Azure Portal eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.
Type:
apiKey
In:
query
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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 säkrare 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 återgivningsmissbruket och regelbundet förnya SAS-token.
Type:
apiKey
In:
header
Exempel
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
GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
Sample Response
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
"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
GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
Sample Response
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-23T19:14:03.2452596+00:00",
"status": "Running"
}
Definitioner
Name | Description |
---|---|
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Long |
Svarsmodellen för ett Long-Running Operations API. |
Lro |
Statustillståndet för begäran. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
LongRunningOperationResult
Svarsmodellen för ett Long-Running Operations API.
Name | Typ | Description |
---|---|---|
created |
string |
Den skapade tidsstämpeln. |
error |
Felinformationen. |
|
operationId |
string |
ID:t för den här långvariga åtgärden. |
status |
Statustillståndet för begäran. |
|
warning |
Felinformationen. |
LroStatus
Statustillståndet för begäran.
Name | Typ | Description |
---|---|---|
Failed |
string |
Begäran har ett eller flera fel. |
NotStarted |
string |
Begäran har inte börjat bearbetas än. |
Running |
string |
Begäran har börjat bearbetas. |
Succeeded |
string |
Begäran har slutförts. |