Data Registry - Register Or Replace

Riferimento

Service:: Maps

API Version:: 2023-06-01

Usare per registrare i dati archiviati in un account di archiviazione di Azure con un account di Mappe di Azure.

L'API Register è una richiesta HTTP PUT usata per registrare i dati in un account di archiviazione di Azure con un account di Mappe di Azure. La dimensione massima del file che può essere registrata è di un gigabyte.

Ciò è utile in scenari come la registrazione di una raccolta di recinti virtuali in GeoJSON formato da usare in Mappe di Azure servizio di geofencing o la registrazione di un set di file di progettazione DWG come pacchetto di disegno compresso da usare nel servizio di conversione creatore Mappe di Azure.

L'endpoint del servizio del Registro dati è limitato nell'ambito dell'area dell'account Mappe di Azure e non è disponibile per gli account di Mappe di Azure globali.

Inviare una richiesta di registrazione o sostituzione

Le Register richieste e Replace sono entrambe operazioni a esecuzione prolungata che contengono un oggetto JSON AzureBlob nel corpo della richiesta che definisce i dettagli del Registro di sistema dei dati.

PUT https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
geography	path	True	string	Questo parametro specifica dove si trova l'account Mappe di Azure. I valori validi sono Stati Uniti orientali, Stati Uniti centro-occidentali, Stati Uniti occidentali 2 e eu (Europa settentrionale, Europa occidentale).
udid	path	True	string	ID dati utente del Registro di sistema dei dati. Regex pattern: `^[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	Numero di versione dell'API di Mappe di Azure.

geography

path

True

string

Questo parametro specifica dove si trova l'account Mappe di Azure. I valori validi sono Stati Uniti orientali, Stati Uniti centro-occidentali, Stati Uniti occidentali 2 e eu (Europa settentrionale, Europa occidentale).

udid

path

True

string

ID dati utente del Registro di sistema dei dati.

Regex pattern: ^[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

Numero di versione dell'API di Mappe di Azure.

Intestazione della richiesta

Nome Necessario Tipo Descrizione

x-ms-client-id

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.
Operation-Id		string	ID operazione, in formato GUID. Regex pattern: `^[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}$`

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.

Operation-Id

string

ID operazione, in formato GUID.

Regex pattern: ^[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}$

Corpo della richiesta

Nome	Tipo	Descrizione
azureBlob	AzureBlob	Dettagli del Registro dati BLOB di Azure.
description	string	Descrizione specificata al Registro di sistema dei dati. La lunghezza massima è 1024 caratteri.
kind	DataRegistryKind	Tipo di registro dati.

Risposte

Nome	Tipo	Descrizione
200 OK	DataRegistry	Sostituzione della risorsa: la richiesta è stata accettata per l'elaborazione. Headers Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Creazione di risorse: la richiesta è stata accettata per l'elaborazione. Headers Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Si è verificato un errore imprevisto. Headers x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

DataRegistry

Sostituzione della risorsa: la richiesta è stata accettata per l'elaborazione.

Headers

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

Creazione di risorse: la richiesta è stata accettata per l'elaborazione.

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

Si è verificato un errore imprevisto.

Headers

x-ms-error-code: string

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.

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

Type: 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 durante la creazione di una 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 questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere considerati come chiavi master per l'account per cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'accesso da server a server delle API REST Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.

Type: apiKey
In: header

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.

Type: apiKey
In: header

Esempio

Register or replace a udid

Sample Request

HTTP

PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01

{
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json"
  }
}

Sample Response

Status code:: 201

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

Response Body

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

Status code:: 200

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

Response Body

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

Definizioni

Nome	Descrizione
AzureBlob	Dettagli del Registro dati BLOB di Azure.
DataFormat	Formato dei dati del contenuto caricato utilizzato a scopo di convalida.
DataRegistry	Registro dei dati in Mappe di Azure.
DataRegistryKind	Tipo di registro dati.
LongRunningOperationStatus	Stato di un'operazione a esecuzione prolungata.
MapsErrorDetail	Dettagli dell'errore.
MapsErrorResponse	Risposta di errore comune per Mappe di Azure API per restituire i dettagli dell'errore per le operazioni non riuscite.
MapsInnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

AzureBlob

Dettagli del Registro dati BLOB di Azure.

Nome	Tipo	Descrizione
blobUrl	string	L'URL del BLOB contiene il percorso del file da registrare.
contentMD5	string	Contenuto MD5 del contenuto, usato per la convalida dei dati.
dataFormat	DataFormat	Formato dei dati del contenuto caricato utilizzato a scopo di convalida.
linkedResource	string	ID dell'archivio dati nell'account Mappe di Azure.
msiClientId	string	ID client dell'identità gestita assegnata dall'utente. Se non specificato, usare l'identità gestita assegnata dal sistema.
sizeInBytes	integer	Dimensioni del contenuto in byte.

DataFormat

Formato dei dati del contenuto caricato utilizzato a scopo di convalida.

Nome	Tipo	Descrizione
geojson	string	GeoJSON è un formato di interscambio dati geospaziale basato su JSON.
zip	string	Formato di dati compressi.

DataRegistry

Registro dei dati in Mappe di Azure.

Nome	Tipo	Descrizione
azureBlob	AzureBlob	Dettagli del Registro dati BLOB di Azure.
description	string	Descrizione specificata al Registro di sistema dei dati. La lunghezza massima è 1024 caratteri.
error	MapsErrorDetail	Dettagli dell'errore.
kind	DataRegistryKind	Tipo di registro dati.
status	LongRunningOperationStatus	Stato di un'operazione a esecuzione prolungata.
udid	string	ID dati utente per il Registro di sistema dei dati.

DataRegistryKind

Tipo di registro dati.

Nome	Tipo	Descrizione
AzureBlob	string	BLOB Azure

LongRunningOperationStatus

Stato di un'operazione a esecuzione prolungata.

Nome	Tipo	Descrizione
Completed	string	La richiesta è stata completata correttamente.
Failed	string	La richiesta presenta uno o più errori.
Running	string	La richiesta è attualmente in elaborazione.

MapsErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Uno dei set definiti dal server di codici di errore.
details	MapsErrorDetail[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	MapsInnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

MapsErrorResponse

Risposta di errore comune per Mappe di Azure API per restituire i dettagli dell'errore per le operazioni non riuscite.

Nome	Tipo	Descrizione
error	MapsErrorDetail	Dettagli dell'errore.

MapsInnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	MapsInnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

Condividi tramite

Data Registry - Register Or Replace

Inviare una richiesta di registrazione o sostituzione

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

AADToken

Note

Scopes

subscription-key

SAS Token

Esempio

Register or replace a udid

Sample Request

Sample Response

Definizioni

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Risorse aggiuntive