Condividi tramite

Dataset - Create

  • Riferimento
Servizio:
Maps Creator
Versione API:
2.0

Usare per creare un set di dati.

L'API Create è una richiesta HTTP POST che accetta il conversionId valore del pacchetto di disegno convertito e restituisce la datasetId proprietà del set di dati appena creato. Per altre informazioni, vedere Creare un set di dati.

È possibile usare questa richiesta in uno scenario come il caricamento di un pacchetto ZIP DWG per un edificio, la conversione del pacchetto ZIP usando il servizio di conversione Mappe di Azure e la creazione di un set di dati dal pacchetto ZIP convertito. Il set di dati creato può essere usato per creare set di tessere usando il servizio Mappe di Azure Tileset e può essere sottoposto a query tramite il servizio Mappe di Azure WFS.

Invia richiesta di creazione

Per creare il set di dati, si userà una POST richiesta in cui il conversionId parametro di query è un ID che rappresenta il pacchetto ZIP DWG convertito, il datasetId parametro è l'ID di un set di dati creato in precedenza da aggiungere con il set di dati corrente e, facoltativamente, il description parametro di query conterrà una descrizione (se la descrizione non fornisce una descrizione predefinita).

L'API Crea è un'operazione a esecuzione prolungata.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}
Con parametri facoltativi: 
POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&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.
conversionId
 query True

string

ID univoco usato per creare il set di dati. L'oggetto conversionId deve essere stato ottenuto da una chiamata riuscita all'API Convert del servizio di conversione e può essere fornito con più parametri di query con lo stesso nome (se vengono forniti più parametri di query).
datasetId
 query

string

ID del set di dati da aggiungere. Il set di dati deve provenire da una chiamata di creazione del set di dati precedente che corrisponde al datasetId
description
 query

string

Descrizione da assegnare al set di dati.

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

Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Se abbinato 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 in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. 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 Mappe di Azure API REST.

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 Mappe di Azure risorsa a cui 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 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 di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

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 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 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 List SAS nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, Azure SDK o 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

Create dataset from a converted CAD file provided by conversionId

Esempio di richiesta

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

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/datasets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

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.