Data Sources - List

Riferimento

Service:: Search Service

API Version:: 2023-11-01

Elenchi tutte le origini dati disponibili per un servizio di ricerca.

GET {endpoint}/datasources?api-version=2023-11-01

With optional parameters:

GET {endpoint}/datasources?$select={$select}&api-version=2023-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
api-version	query	True	string	Versione dell'API client.
$select	query		string	Seleziona le proprietà di primo livello delle origini dati da recuperare. Specificato come elenco delimitato da virgole di nomi di proprietà JSON o `*` per tutte le proprietà. Il valore predefinito è tutte le proprietà.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string uuid	ID di rilevamento inviato con la richiesta di assistenza per il debug.

Risposte

Nome	Tipo	Descrizione
200 OK	ListDataSourcesResult
Other Status Codes	SearchError	Risposta di errore.

Esempio

SearchServiceListDataSources

Sample Request

HTTP

GET https://myservice.search.windows.net/datasources?$select=*&api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "mydocdbdatasource",
      "description": "My Cosmos DB data source.",
      "type": "cosmosdb",
      "credentials": {
        "connectionString": null
      },
      "container": {
        "name": "myDocDbCollectionId",
        "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts"
      },
      "dataChangeDetectionPolicy": {
        "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
        "highWaterMarkColumnName": "_ts"
      },
      "dataDeletionDetectionPolicy": {
        "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
        "softDeleteColumnName": "isDeleted",
        "softDeleteMarkerValue": "true"
      },
      "encryptionKey": {
        "keyVaultKeyName": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": null
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
AzureActiveDirectoryApplicationCredentials	Credenziali di un'applicazione registrata creata per il servizio di ricerca, usata per l'accesso autenticato alle chiavi di crittografia archiviate in Azure Key Vault.
DataSourceCredentials	Rappresenta le credenziali che possono essere usate per la connessione a un'origine dati.
HighWaterMarkChangeDetectionPolicy	Definisce un criterio di rilevamento delle modifiche dei dati che acquisisce le modifiche in base al valore di una colonna di contrassegno di acqua elevata.
ListDataSourcesResult	Risposta da una richiesta List Datasources. In caso di esito positivo, include le definizioni complete di tutte le origini dati.
SearchError	Descrive una condizione di errore per l'API.
SearchIndexerDataContainer	Rappresenta informazioni sull'entità , ad esempio Azure SQL tabella o raccolta CosmosDB, indicizzate.
SearchIndexerDataSource	Rappresenta una definizione dell'origine dati, che può essere usata per configurare un indicizzatore.
SearchIndexerDataSourceType	Definisce il tipo di un'origine dati.
SearchResourceEncryptionKey	Chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite possono essere usate per crittografare o decrittografare i dati inattivi nel servizio di ricerca, ad esempio indici e mappe sinonimi.
SoftDeleteColumnDeletionDetectionPolicy	Definisce un criterio di rilevamento dell'eliminazione dei dati che implementa una strategia di eliminazione temporanea. Determina se un elemento deve essere eliminato in base al valore di una colonna "eliminazione temporanea".
SqlIntegratedChangeTrackingPolicy	Definisce un criterio di rilevamento delle modifiche ai dati che acquisisce le modifiche usando la funzionalità Integrata Rilevamento modifiche di Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Credenziali di un'applicazione registrata creata per il servizio di ricerca, usata per l'accesso autenticato alle chiavi di crittografia archiviate in Azure Key Vault.

Nome	Tipo	Descrizione
applicationId	string	ID applicazione AAD che ha concesso le autorizzazioni di accesso necessarie all'Key Vault di Azure da usare durante la crittografia dei dati inattivi. L'ID applicazione non deve essere confuso con l'ID oggetto per l'applicazione AAD.
applicationSecret	string	Chiave di autenticazione dell'applicazione AAD specificata.

DataSourceCredentials

Rappresenta le credenziali che possono essere usate per la connessione a un'origine dati.

Nome	Tipo	Descrizione
connectionString	string	Stringa di connessione per l'origine dati. Impostare su `<unchanged>` (con parentesi quadre) se non si vuole aggiornare il stringa di connessione. Impostare su `<redacted>` se si vuole rimuovere il valore stringa di connessione dall'origine dati.

HighWaterMarkChangeDetectionPolicy

Definisce un criterio di rilevamento delle modifiche dei dati che acquisisce le modifiche in base al valore di una colonna di contrassegno di acqua elevata.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Un frammento URI che specifica il tipo di criterio di rilevamento delle modifiche dei dati.
highWaterMarkColumnName	string	Nome della colonna del contrassegno dell'acqua elevata.

ListDataSourcesResult

Risposta da una richiesta List Datasources. In caso di esito positivo, include le definizioni complete di tutte le origini dati.

Nome	Tipo	Descrizione
value	SearchIndexerDataSource[]	Origini dati nella servizio di ricerca.

SearchError

Descrive una condizione di errore per l'API.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	SearchError[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
message	string	Rappresentazione leggibile dell'errore.

SearchIndexerDataContainer

Rappresenta informazioni sull'entità , ad esempio Azure SQL tabella o raccolta CosmosDB, indicizzate.

Nome	Tipo	Descrizione
name	string	Nome della tabella o della vista (per Azure SQL origine dati) o raccolta (per l'origine dati cosmosDB) indicizzata.
query	string	Query applicata a questo contenitore di dati. La sintassi e il significato di questo parametro è specifica dell'origine dati. Non supportato da Azure SQL origini dati.

SearchIndexerDataSource

Rappresenta una definizione dell'origine dati, che può essere usata per configurare un indicizzatore.

Nome	Tipo	Descrizione
@odata.etag	string	ETag dell'origine dati.
container	SearchIndexerDataContainer	Contenitore di dati per l'origine dati.
credentials	DataSourceCredentials	Credenziali per l'origine dati.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Criteri di rilevamento delle modifiche dei dati per l'origine dati.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Criteri di rilevamento dell'eliminazione dei dati per l'origine dati.
description	string	Descrizione dell'origine dati.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia inattivo per la definizione dell'origine dati quando si vuole garantire che nessuno, non anche Microsoft, possa decrittografare la definizione dell'origine dati. Dopo aver crittografato la definizione dell'origine dati, rimarrà sempre crittografato. Il servizio di ricerca ignora i tentativi di impostare questa proprietà su Null. È possibile modificare questa proprietà in base alle esigenze se si vuole ruotare la chiave di crittografia; La definizione dell'origine dati non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati o dopo il 1° gennaio 2019.
name	string	Nome dell'origine dati.
type	SearchIndexerDataSourceType	Tipo dell'origine dati.

SearchIndexerDataSourceType

Definisce il tipo di un'origine dati.

Nome	Tipo	Descrizione
adlsgen2	string	Indica un'origine dati ADLS Gen2.
azureblob	string	Indica un'origine dati BLOB di Azure.
azuresql	string	Indica un'origine dati Azure SQL.
azuretable	string	Indica un'origine dati tabella di Azure.
cosmosdb	string	Indica un'origine dati cosmosDB.
mysql	string	Indica un'origine dati MySql.

SearchResourceEncryptionKey

Chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite possono essere usate per crittografare o decrittografare i dati inattivi nel servizio di ricerca, ad esempio indici e mappe sinonimi.

Nome	Tipo	Descrizione
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenziali facoltative di Azure Active Directory usate per accedere all'Key Vault di Azure. Non richiesto se si usa invece l'identità gestita.
keyVaultKeyName	string	Nome della chiave di Key Vault di Azure da usare per crittografare i dati inattivi.
keyVaultKeyVersion	string	Versione della chiave di Key Vault di Azure da usare per crittografare i dati inattivi.
keyVaultUri	string	URI dell'Key Vault di Azure, noto anche come nome DNS, che contiene la chiave da usare per crittografare i dati inattivi. Un URI di esempio potrebbe essere `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Definisce un criterio di rilevamento dell'eliminazione dei dati che implementa una strategia di eliminazione temporanea. Determina se un elemento deve essere eliminato in base al valore di una colonna "eliminazione temporanea".

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Un frammento URI che specifica il tipo di criterio di rilevamento dell'eliminazione dei dati.
softDeleteColumnName	string	Nome della colonna da usare per il rilevamento dell'eliminazione temporanea.
softDeleteMarkerValue	string	Valore del marcatore che identifica un elemento come eliminato.

SqlIntegratedChangeTrackingPolicy

Definisce un criterio di rilevamento delle modifiche ai dati che acquisisce le modifiche usando la funzionalità Integrata Rilevamento modifiche di Azure SQL Database.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Un frammento URI che specifica il tipo di criterio di rilevamento delle modifiche dei dati.

Condividi tramite