Data Registry - Get Operation

Service:

Maps

API Version:

2023-06-01

Gebruik om de status van het gegevensregister of de vervangingsaanvraag te controleren.
De Get Operation API is een HTTP-aanvraag GET die wordt gebruikt om de status van een gegevensregister op te halen of de vervangingsaanvraag wordt geretourneerd in de header van het register of vervangen antwoord als de waarde van de Operation-Location sleutel. Tijdens de uitvoering wordt een HTTP-antwoord 200 OK geretourneerd met Retry-After een header, gevolgd door een HTTP 200 OK zonder extra header zodra dit is voltooid.

Het service-eindpunt van het gegevensregister is beperkt tot de regio van uw Azure Maps-account en is niet beschikbaar voor globale Azure Maps-accounts.

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

URI-parameters

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar het Azure Maps-account zich bevindt. Geldige waarden zijn us (VS - oost, VS - west-centraal, VS - west 2) en eu (Europa - noord, Europa - west).
operationId	path	True	string	De id die wordt gebruikt om de status van een aanvraag voor een gegevensregister op te vragen. 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	Het versienummer van Azure Maps API.

Antwoorden

Name	Type	Description
200 OK	LongRunningOperationResult	De status van de langlopende bewerking. Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	Er is een onverwachte fout opgetreden. Headers x-ms-error-code: string

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

• Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

• Zie overzicht van Microsoft identity platform voor meer informatie over 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

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel is elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's, waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

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"
}

Definities

Name	Description
LongRunningOperationResult	Het antwoordmodel voor een langlopende bewerking.
LongRunningOperationStatus	De status van een langlopende bewerking.
MapsErrorDetail	De foutdetails.
MapsErrorResponse	Veelvoorkomende foutreacties voor Azure Maps API's om foutdetails te retourneren voor mislukte bewerkingen.
MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.

LongRunningOperationResult

Het antwoordmodel voor een langlopende bewerking.

Name	Type	Description
error	MapsErrorDetail	De foutdetails.
id	string	De operationId
status	LongRunningOperationStatus	De status van een langlopende bewerking.

LongRunningOperationStatus

De status van een langlopende bewerking.

Name	Type	Description
Completed	string	De aanvraag is voltooid.
Failed	string	De aanvraag heeft een of meer fouten.
Running	string	De aanvraag wordt momenteel verwerkt.

MapsErrorDetail

De foutdetails.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	MapsErrorDetail[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

MapsErrorResponse

Veelvoorkomende foutreacties voor Azure Maps API's om foutdetails te retourneren voor mislukte bewerkingen.

Name	Type	Description
error	MapsErrorDetail	De foutdetails.

MapsInnerError

Een object met specifiekere informatie dan het huidige object over de fout.

Name	Type	Description
code	string	De foutcode.
innererror	MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.