Condividi tramite


Data Registry - List

Usare per ottenere un elenco di tutti i registri dati nell'account Mappe di Azure.

L'API List è una richiesta HTTP GET che restituisce una matrice contenente tutti i registri dati registrati in precedenza usando l'API Register o Replace.

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

Invia richiesta elenco

Per elencare tutti i registri dati, eseguire una GET richiesta senza parametri aggiuntivi.

Risposta elenco

La List richiesta restituisce una matrice di registri dati in JSON formato nel corpo della risposta.

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

Parametri dell'URI

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

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

Risposte

Nome Tipo Descrizione
200 OK

DataRegistryList

La List richiesta è stata completata correttamente. Il corpo della risposta contiene una matrice di registri dati.

Other Status Codes

MapsErrorResponse

Si è verificato un errore imprevisto.

Intestazioni

x-ms-error-code: string

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.

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 durante la creazione di una risorsa di 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 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 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

List all previously registered data registries

Esempio di richiesta

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Risposta di esempio

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "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/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

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.

DataRegistryList

Modello di risposta per l'API dell'elenco dei dati. Restituisce un elenco di tutti i dati registrati in precedenza.

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

DataRegistryList

Modello di risposta per l'API dell'elenco dei dati. Restituisce un elenco di tutti i dati registrati in precedenza.

Nome Tipo Descrizione
nextLink

string

URL per ottenere il set successivo di registri dati.

value

DataRegistry[]

Matrice di registri dati.

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