Share via

Data Registry - Get Operation

  • Referenz
Service:
Maps
API Version:
2023-06-01

Verwenden Sie , um die status des Datenregisters oder der Ersetzungsanforderung zu überprüfen.
Die Get Operation API ist eine HTTP-AnforderungGET, die verwendet wird, um die status eines Datenregisters abzurufen, oder die Ersetzungsanforderung wird im Header des Registers oder der Ersetzungsantwort als Wert des Operation-Location Schlüssels zurückgegeben. Während der Ausführung wird eine HTTP-Antwort 200 OK mit Retry-After einem Header zurückgegeben, gefolgt von einem HTTP 200 OK ohne zusätzlichen Header nach Abschluss.

Der Datenregistrierungsdienstendpunkt ist im Bereich auf die Region Ihres Azure Maps-Kontos beschränkt und für globale Azure Maps-Konten nicht verfügbar.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
geography
 path True

string

Dieser Parameter gibt an, wo sich das Azure Maps-Konto befindet. Gültige Werte sind us (USA, Osten, USA, Westen-Mitte, USA, Westen-Mitte 2) und eu (Europa, Norden, Europa, Westen).
operationId
 path True

string

Die ID, die zum Abfragen der status einer Datenregisteranforderung verwendet wird.

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

Die Versionsnummer der Azure Maps-API.

Antworten

Name Typ Beschreibung
200 OK

LongRunningOperationResult

Die status des zeitintensiven Vorgangs.

Headers

Retry-After: integer
Other Status Codes

MapsErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Headers

x-ms-error-code: string

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweise

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Anders ausgedrückt: Diese können derzeit als master Schlüssel für das Konto behandelt werden, für das sie ausgestellt wurden.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: header

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

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

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

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

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

Definitionen

Name Beschreibung
LongRunningOperationResult

Das Antwortmodell für einen Vorgang mit langer Ausführungsdauer.
LongRunningOperationStatus

Die status eines Vorgangs mit langer Ausführungsdauer.
MapsErrorDetail

Die Fehlerdetails.
MapsErrorResponse

Allgemeine Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
MapsInnerError

Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

LongRunningOperationResult

Das Antwortmodell für einen Vorgang mit langer Ausführungsdauer.

Name Typ Beschreibung
error

MapsErrorDetail

Die Fehlerdetails.
id

string

Die operationId
status

LongRunningOperationStatus

Die status eines Vorgangs mit langer Ausführungsdauer.

LongRunningOperationStatus

Die status eines Vorgangs mit langer Ausführungsdauer.

Name Typ Beschreibung
Completed

string

Die Anforderung wurde erfolgreich abgeschlossen.
Failed

string

Die Anforderung weist einen oder mehrere Fehler auf.
Running

string

Die Anforderung wird derzeit verarbeitet.

MapsErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
code

string

Einer von einem serverdefiniertem Satz von Fehlercodes.
details

MapsErrorDetail[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror

MapsInnerError

Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message

string

Eine lesbare Darstellung des Fehlers.
target

string

Das Ziel des Fehlers.

MapsErrorResponse

Allgemeine Fehlerantwort für Azure Maps-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

Name Typ Beschreibung
error

MapsErrorDetail

Die Fehlerdetails.

MapsInnerError

Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.
innererror

MapsInnerError

Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.