Data Registry - Get Operation

Referenz

Dienst:: Maps

API-Version:: 2023-06-01

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

Der Endpunkt des Datenregistrierungsdiensts ist 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

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 2) und eu (Europa, Norden, Europa, Westen).
operationId	path	True	string	Die ID, die verwendet wird, um den Status einer Datenregisteranforderung abzufragen. RegEx-Muster: `^[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.

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 2) und eu (Europa, Norden, Europa, Westen).

operationId

path

True

string

Die ID, die verwendet wird, um den Status einer Datenregisteranforderung abzufragen.

RegEx-Muster: ^[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	Der Status des Vorgangs mit langer Ausführungsdauer. Header Retry-After: integer
Other Status Codes	MapsErrorResponse	Ein unerwarteter Fehler ist aufgetreten. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

LongRunningOperationResult

Der Status des Vorgangs mit langer Ausführungsdauer.

Header

Retry-After: integer

Other Status Codes

MapsErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Header

x-ms-error-code: string

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

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

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Übersicht über Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

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

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Mit anderen Worten, diese können derzeit als Masterschlü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.

Typ: apiKey
In: header

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Get the status of an operation that is still running

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

Retry-After: 10

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

Definitionen

Name	Beschreibung
LongRunningOperationResult	Das Antwortmodell für einen Vorgang mit langer Ausführungsdauer.
LongRunningOperationStatus	Der Status eines Vorgangs mit langer Ausführungsdauer.
MapsErrorDetail	Die Fehlerdetails.
MapsErrorResponse	Häufige 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	Der Status eines Vorgangs mit langer Ausführungsdauer.

LongRunningOperationStatus

Der Status eines Vorgangs mit langer Ausführungsdauer.

Name	Typ	Beschreibung
Completed	string	Die Anforderung wurde erfolgreich abgeschlossen.
Failed	string	Die Anforderung weist mindestens einen Fehler auf.
Running	string	Die Anforderung wird derzeit verarbeitet.

MapsErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten 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 für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

MapsErrorResponse

Häufige 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.

Freigeben über

Data Registry - Get Operation

URI-Parameter

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

Get the status of an operation that failed

Beispielanforderung

Beispiel für eine Antwort

Get the status of an operation that finished successfully

Beispielanforderung

Beispiel für eine Antwort

Get the status of an operation that is still running

Beispielanforderung

Beispiel für eine Antwort

Definitionen

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Zusätzliche Ressourcen