Data - Update
Dient zum Aktualisieren von Dateninhalten, die zuvor mithilfe des Datenuploads hochgeladen wurden.
Hinweis
Einstellung des Azure Maps-Datendiensts
Der Azure Maps-Datendienst (v1 und v2) ist jetzt veraltet und wird am 16.09.2024 eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Aufrufe des Datendiensts aktualisiert werden, um den Azure Maps Datenregistrierungsdienst bis zum 16.09.24 zu verwenden. Weitere Informationen finden Sie unter So erstellen Sie eine Datenregistrierung.
Die Data Update
API ist eine HTTP-Anforderung PUT
, mit der der Aufrufer zuvor hochgeladene Dateninhalte aktualisieren kann.
Sie können diese API in einem Szenario wie dem Hinzufügen oder Entfernen von Geofences zu oder aus einer vorhandenen Sammlung von Geofences verwenden. Geofences werden mithilfe der Datenupload-API zur Verwendung im Azure Maps Geofencing Service hochgeladen.
Beachten Sie, dass die Update-API den vorhandenen Dateninhalt ersetzt und überschreibt .
Wichtig
Durch die Verwendung dieses Features stimmen Sie den rechtlichen Bestimmungen für die Vorschau zu. Weitere Details finden Sie in der Vorschau der ergänzenden Bedingungen .
Übermitteln der Updateanforderung
Um Ihre Inhalte zu aktualisieren, verwenden Sie eine PUT
Anforderung. Der Anforderungstext enthält die neuen Daten, die die vorhandenen Daten ersetzen. Der Content-Type
Header wird auf den Inhaltstyp der Daten festgelegt, und der Pfad enthält die udid
der zu aktualisierenden Daten.
Wenn Sie beispielsweise eine Sammlung von Geofences aktualisieren möchten, die zuvor mit der Upload-API hochgeladen wurden, platzieren Sie den neuen Geofence-Inhalt im Anforderungstext. Legen Sie den udid
Parameter im Pfad der Daten fest, die udid
zuvor in der Upload-API-Antwort empfangen wurden. Legen Sie den Content-Type
Header auf einen der folgenden Medientypen fest:
application/json
application/vnd.geo+json
application/octet-stream
Hier sehen Sie ein Beispiel für den Anforderungstext zum Aktualisieren eines einfachen Geofences. Sie wird als Kreisgeometrie mit einem Mittelpunkt und einem Radius dargestellt. Das folgende Beispiel ist in GeoJSON
:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-122.126986, 47.639754]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}]
}
Der zuvor hochgeladene Geofence hatte einen Radius von 100m. Die obige Anforderung aktualisiert sie auf 500m.
Die Datenupdate-API führt einen Vorgang mit langer Ausführungszeit aus.
Grenzwerte für Datenupdates
Bitte beachten Sie, dass derzeit für jedes Azure Maps-Konto ein Datenspeicherlimit gilt. Sobald das Speicherlimit erreicht ist, geben alle neuen Upload-API-Aufrufe eine 409 Conflict
HTTP-Fehlerantwort zurück. Sie können jederzeit die Datenlösch-API verwenden, um alte/nicht verwendete Inhalte zu löschen und Speicherplatz für neue Uploads zu schaffen.
PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0
PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0&description={description}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
geography
|
path | True |
string |
Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind "us" und "eu". |
udid
|
path | True |
string |
Die eindeutige Daten-ID für den Inhalt. Die |
api-version
|
query | True |
string |
Versionsnummer der Azure Maps API. |
description
|
query |
string |
Die Beschreibung, die dem Upload zugewiesen werden soll. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-id |
string |
Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
UpdateContent |
object |
Der neue Inhalt, der den zuvor hochgeladenen Inhalt aktualisiert/ersetzt. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Vorgang wird ausgeführt oder abgeschlossen. Wenn der Vorgang erfolgreich war, verwenden Sie den Resource-Location-Header, um den Pfad zum Ergebnis abzurufen. Headers Resource-Location: string |
|
202 Accepted |
Anforderung akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert. Verwenden Sie die URL im Operation-Location-Header, um status zu erhalten. Headers Operation-Location: string |
|
Other Status Codes |
Das Datenspeicherlimit wird für das Azure Maps-Konto erreicht. Sie können jederzeit die Datenlösch-API verwenden, um alte/nicht verwendete Inhalte zu löschen und Speicherplatz für neue Uploads zu schaffen. |
|
Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. |
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.
- Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.
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 bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API Create.
Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.
Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen für den Zugriff auf Azure Maps REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.
Type:
apiKey
In:
query
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
Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences
Sample Request
PUT https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}
]
}
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"
}
Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0
Access-Control-Expose-Headers: Operation-Location
{
"error": {
"code": "409 Conflict",
"message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads."
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Long |
Das Antwortmodell für eine Long-Running Operations-API. |
Lro |
Der status Status der Anforderung. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
LongRunningOperationResult
Das Antwortmodell für eine Long-Running Operations-API.
Name | Typ | Beschreibung |
---|---|---|
created |
string |
Der erstellte Zeitstempel. |
error |
Die Fehlerdetails. |
|
operationId |
string |
Die ID für diesen vorgang mit langer Ausführungsdauer. |
status |
Der status Status der Anforderung. |
|
warning |
Die Fehlerdetails. |
LroStatus
Der status Status der Anforderung.
Name | Typ | Beschreibung |
---|---|---|
Failed |
string |
Die Anforderung weist einen oder mehrere Fehler auf. |
NotStarted |
string |
Die Verarbeitung der Anforderung wurde noch nicht gestartet. |
Running |
string |
Die Verarbeitung der Anforderung wurde gestartet. |
Succeeded |
string |
Die Anforderung wurde erfolgreich abgeschlossen. |