Tileset - Create

Servizio:

Maps Creator

Versione API:

2.0

Usare per creare un set di riquadri.

L'API Create è una richiesta HTTP POST utilizzata per creare un set di riquadri dal set di dati specificato. Per altre informazioni, vedere Creare un set di riquadri. Un set di riquadri contiene un set di riquadri che possono essere usati usando Get Map Tile per recuperare riquadri personalizzati. Per creare un set di dati, usare Creazione set di dati. Per un'introduzione ai concetti e agli strumenti che si applicano all'Mappe di Azure Creator, vedere Creator per mappe interne.

L'API Create Tileet è un'operazione a esecuzione prolungata.

Invia richiesta di creazione

Per creare il set di riquadri, si eseguirà una POST richiesta con un corpo vuoto. Il datasetId parametro di query verrà usato come origine dei dati del set di riquadri.

POST https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0&datasetId={datasetId}

Con parametri facoltativi:

POST https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0&datasetId={datasetId}&description={description}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
geography	path	True	string	Questo parametro specifica dove si trova la risorsa Mappe di Azure Creator. I valori validi sono noi ed eu.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
datasetId	query	True	string	Univoco datasetId utilizzato dall'API di creazione del set di riquadri per recuperare le funzionalità per generare riquadri. L'oggetto datasetId deve essere stato ottenuto da una chiamata API Create set di dati riuscita.
description	query		string	L'utente ha fornito la descrizione del set di riquadri.

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 del piano di gestione Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	LongRunningOperationResult	L'operazione è in esecuzione o completa. Se l'operazione ha 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	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. 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 Mappe di Azure API REST.

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

Note

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

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

• Per altre informazioni su Microsoft Identity Platform, vedere panoramica Microsoft Identity Platform.

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

Ambiti

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

subscription-key

Si tratta di una chiave condivisa di cui viene eseguito il provisioning quando si crea un account Mappe di Azure nell'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 delle applicazioni client riservate per accedere alle API REST 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 Elenco firma di accesso condiviso nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso basati sul 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 account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Create Tileset by providing a Dataset Id

Esempio di richiesta

HTTP

POST https://us.atlas.microsoft.com/tilesets?api-version=2.0&datasetId=[dataset-Id]

Risposta di esempio

Codice di stato:

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

Codice di stato:

202

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

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sulla 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 sulla 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 ha 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.