Data - Update

Riferimento

Servizio:: Maps

Versione API:: 2.0

Usare per aggiornare il contenuto dei dati caricato in precedenza usando caricamento dati.

Nota

Ritiro del servizio dati di Mappe di Azure

Il servizio dati di Mappe di Azure ( v1 e v2) è ora deprecato e verrà ritirato il 16/9/24. Per evitare interruzioni del servizio, tutte le chiamate al servizio dati dovranno essere aggiornate per usare il servizio Registro dati di Mappe di Azure entro il 16/09/24. Per altre informazioni, vedere Come creare il Registro di sistema dei dati.

L'API Data Update è una richiesta HTTP PUT che consente al chiamante di aggiornare il contenuto dei dati caricato in precedenza.

È possibile usare questa API in uno scenario come l'aggiunta o la rimozione di recinti virtuali da o verso una raccolta esistente di recinti virtuali. I recinti virtuali vengono caricati usando l'API Caricamento dati per l'uso nel servizio geofencing di Mappe di Azure.

Si noti che l'API di aggiornamento sostituirà e sostituirà il contenuto dei dati esistente.

Importante

Usando questa funzionalità, si accettano le condizioni legali di anteprima. Per altri dettagli, vedere Le condizioni supplementari per l'anteprima .

Invia richiesta di aggiornamento

Per aggiornare il contenuto, si userà una PUT richiesta. Il corpo della richiesta conterrà i nuovi dati che sostituiranno i dati esistenti. L'intestazione Content-Type verrà impostata sul tipo di contenuto dei dati e il percorso conterrà i udid dati da aggiornare.

Ad esempio, per aggiornare una raccolta di recinti virtuali caricati in precedenza usando l'API Di caricamento, inserire il nuovo contenuto del recinto virtuale nel corpo della richiesta. Impostare il udid parametro nel percorso dell'oggetto udid dei dati ricevuti in precedenza nella risposta dell'API di caricamento. Impostare l'intestazione Content-Type su uno dei tipi di supporti seguenti:

application/json
application/vnd.geo+json
application/octet-stream

Ecco un corpo di richiesta di esempio per l'aggiornamento di un semplice Recinto virtuale. Viene rappresentato come geometria circolare usando un punto centrale e un raggio. L'esempio seguente è in GeoJSON:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

Il recinto virtuale caricato in precedenza aveva un raggio di 100 m. La richiesta precedente verrà aggiornata a 500m.

L'API Aggiornamento dati esegue un'operazione a esecuzione prolungata.

Limiti relativi all'aggiornamento dei dati

Tenere presente che attualmente ogni account di Mappe di Azure ha un limite di archiviazione dei dati. Una volta raggiunto il limite di archiviazione, tutte le nuove chiamate API di caricamento restituiranno una 409 Conflict risposta di errore HTTP. È sempre possibile usare l'API Di eliminazione dati per eliminare il contenuto precedente/inutilizzato e creare spazio per i nuovi caricamenti.

PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0

Con parametri facoltativi:

PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0&description={description}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
geography	path	True	string	Questo parametro specifica dove si trova la risorsa Creator di Mappe di Azure. I valori validi sono noi ed eu.
udid	path	True	string	ID dati univoco per il contenuto. L'oggetto `udid` deve essere stato ottenuto da una chiamata di caricamento dati riuscita.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
description	query		string	Descrizione da assegnare al caricamento.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

Corpo della richiesta

Nome	Tipo	Descrizione
UpdateContent	object	Nuovo contenuto che aggiornerà/sostituirà il contenuto caricato in precedenza.

Risposte

Nome	Tipo	Descrizione
200 OK	LongRunningOperationResult	L'operazione è in esecuzione o completata. Se l'operazione ha avuto esito positivo, usare l'intestazione Resource-Location per ottenere il percorso del risultato. Intestazioni Resource-Location: string
202 Accepted		Richiesta accettata: la richiesta è stata accettata per l'elaborazione. Usare l'URL nell'intestazione Operation-Location per ottenere lo stato. Intestazioni Operation-Location: string
Other Status Codes	ErrorResponse	Il limite di archiviazione dei dati viene raggiunto nell'account Mappe di Azure. È sempre possibile usare l'API Di eliminazione dati per eliminare il contenuto precedente/inutilizzato e creare spazio per i nuovi caricamenti.
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi Microsoft Entra OAuth 2.0 . Se abbinato al controllo degli accessi in base al ruolo di Azure , può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe .

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni ID Microsoft Entra. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST. * L'utilizzo di Azure Maps Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Per altre informazioni su Microsoft Identity Platform, vedere Panoramica di Microsoft Identity Platform.

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

Scopes

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si crea un account mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio alle applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenca firma di accesso condiviso nella risorsa mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample request

HTTP

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

Status code:: 200

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

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0
Access-Control-Expose-Headers: Operation-Location

Status code:: 409

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

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
LongRunningOperationResult	Modello di risposta per un'API operations di Long-Running.
LroStatus	Stato della richiesta.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

LongRunningOperationResult

Modello di risposta per un'API operations di Long-Running.

Nome	Tipo	Descrizione
created	string	Timestamp creato.
error	ErrorDetail	Dettagli dell'errore.
operationId	string	ID per questa operazione a esecuzione prolungata.
status	LroStatus	Stato della richiesta.
warning	ErrorDetail	Dettagli dell'errore.

LroStatus

Stato della richiesta.

Nome	Tipo	Descrizione
Failed	string	La richiesta presenta uno o più errori.
NotStarted	string	La richiesta non ha ancora avviato l'elaborazione.
Running	string	La richiesta ha avviato l'elaborazione.
Succeeded	string	La richiesta è stata completata correttamente.

Condividi tramite