Data Registry - Get Data Registry

Riferimento

Servizio:: Maps

Versione API:: 2023-06-01

Usare per ottenere le informazioni del Registro dati specificate.

L'API Get Data Registry è una richiesta HTTP GET che restituisce informazioni sul Registro dati, come oggetto AzureBlob in formato JSON, nel corpo della risposta, insieme al codice di stato HTTP 200, quando ha esito positivo. Se Mappe di Azure non è in grado di accedere al contenuto sottostante o il controllo di integrità non riesce, viene status impostato su Failed e viene restituito un errore.

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

Invia richiesta del Registro dati

Una richiesta del Registro dati restituisce i dettagli del Registro GET dati richiesti, come determinato dall'oggetto specificato udid. I dettagli vengono restituiti nel corpo della risposta in formato JSON.

GET 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 (Stati Uniti orientali, Stati Uniti centro-occidentali, Stati Uniti occidentali 2) ed eu (Europa settentrionale, Europa occidentale).
udid	path	True	string	ID dati utente del Registro dati. Criterio di espressione regolare: `^[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 Mappe di Azure.

geography

path

True

string

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

udid

path

True

string

ID dati utente del Registro dati.

Criterio di espressione regolare: ^[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 Mappe di Azure.

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 la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	DataRegistry	La `Get Data Registry` richiesta è stata completata correttamente. Il corpo della risposta contiene il Registro dati dell'oggetto specificato `udid`.
Other Status Codes	MapsErrorResponse	Si è verificato un errore imprevisto. Intestazioni x-ms-error-code: string

DataRegistry

La Get Data Registry richiesta è stata completata correttamente. Il corpo della risposta contiene il Registro dati dell'oggetto specificato udid.

Other Status Codes

MapsErrorResponse

Si è verificato un errore imprevisto.

Intestazioni

x-ms-error-code: string

Sicurezza

AADToken

Si tratta dei flussi di Microsoft Entra OAuth 2.0 . Quando è associato 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 basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più account delle risorse delle risorse di Mappe di Azure 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 le API REST di Mappe di Azure.

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 la risorsa mappe di Azure 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 dispongono di URL di autorizzazione univoci e configurazioni di Microsoft Entra ID. * 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
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 durante la creazione di una risorsa mappe di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente 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 di Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.

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

Get the data registry of a completed udid

Get the data registry of a failed udid

Get the data registry of a completed udid

Esempio di richiesta

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Risposta di esempio

Codice di stato:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "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,
    "contentMD5": "sOJMJvFParkSxBsvvrPOMQ=="
  },
  "status": "Completed"
}

Get the data registry of a failed udid

Esempio di richiesta

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Risposta di esempio

Codice di stato:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "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"
  },
  "status": "Failed",
  "error": {
    "code": "AuthorizationPermissionMismatch",
    "message": "Not authorized to perform this operation on resource: https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json."
  }
}

Definizioni

Nome	Descrizione
AzureBlob	Dettagli del Registro dati BLOB di Azure.
DataFormat	Formato dei dati del contenuto caricato usato a scopo di convalida.
DataRegistry	Registro 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 le API di Mappe di Azure per restituire i dettagli degli errori 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 registrato.
contentMD5	string	Contenuto MD5 del contenuto, usato per la convalida dei dati.
dataFormat	DataFormat	Formato dei dati del contenuto caricato usato 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. Usare l'identità gestita assegnata dal sistema se non specificata.
sizeInBytes	integer	Dimensioni del contenuto in byte.

DataFormat

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

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

DataRegistry

Registro dati in Mappe di Azure.

Nome	Tipo	Descrizione
azureBlob	AzureBlob	Dettagli del Registro dati BLOB di Azure.
description	string	Descrizione specificata nel Registro dati. La lunghezza massima è di 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 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 ha uno o più errori.
Running	string	La richiesta è attualmente in fase di elaborazione.

MapsErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	MapsErrorDetail[]	Matrice di dettagli sugli errori specifici che hanno causato l'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 le API di Mappe di Azure per restituire i dettagli degli errori 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 - Get Data Registry

Invia richiesta del Registro dati

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Note

Ambiti

subscription-key

SAS Token

Esempio

Get the data registry of a completed udid

Esempio di richiesta

Risposta di esempio

Get the data registry of a failed udid

Esempio di richiesta

Risposta di esempio

Definizioni

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Risorse aggiuntive