Data Sources - Get

Servizio:: Search Service

Versione API:: 2025-08-01-preview

Recupera una definizione dell'origine dati.

GET {endpoint}/datasources('{dataSourceName}')?api-version=2025-08-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dataSourceName	path	True	string	Nome dell'origine dati da recuperare.
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
api-version	query	True	string	Versione dell'API client.

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	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Risposta di errore.

Esempio

SearchServiceGetDataSource

Esempio di richiesta

HTTP

GET https://previewexampleservice.search.windows.net/datasources('mydocdbdatasource')?api-version=2025-08-01-preview

Risposta di esempio

Codice di stato:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mydocdbdatasource",
  "description": "My Azure Adls Gen2 data source with ACLs.",
  "type": "adlsgen2",
  "indexerPermissionOptions": [
    "userIds",
    "groupIds",
    "rbacScope"
  ],
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "adls-gen2-doc-extraction-acl",
    "query": "folder_has_final_acl"
  },
  "dataChangeDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
    "highWaterMarkColumnName": "metadata_storage_last_modified"
  },
  "dataDeletionDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true"
  }
}

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 utilizzate per connettersi a un'origine dati.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
HighWaterMarkChangeDetectionPolicy	Definisce un criterio di rilevamento delle modifiche dei dati che acquisisce le modifiche in base al valore di una colonna di limite massimo.
IndexerPermissionOption	Opzioni con vari tipi di dati di autorizzazione per l'indicizzazione.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definisce un criterio di rilevamento dell'eliminazione dei dati usando la funzionalità di eliminazione temporanea nativa di Archiviazione BLOB di Azure per il rilevamento dell'eliminazione.
SearchIndexerDataContainer	Rappresenta le informazioni sull'entità (ad esempio la tabella SQL di Azure o la raccolta CosmosDB) che verrà indicizzata.
SearchIndexerDataNoneIdentity	Cancella la proprietà identity di un'origine dati.
SearchIndexerDataSource	Rappresenta una definizione dell'origine dati, che può essere utilizzata per configurare un indicizzatore.
SearchIndexerDataSourceType	Definisce il tipo di un'origine dati.
SearchIndexerDataUserAssignedIdentity	Specifica l'identità da utilizzare per un'origine dati.
SearchResourceEncryptionKey	Una chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite dall'utente possono essere utilizzate per crittografare o decrittografare i dati inattivi, ad esempio indici e mappe di 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 di "eliminazione temporanea" designata.
SqlIntegratedChangeTrackingPolicy	Definisce un criterio di rilevamento delle modifiche dei dati che acquisisce le modifiche usando la funzionalità di rilevamento delle modifiche integrata del database SQL di Azure.

AzureActiveDirectoryApplicationCredentials

Oggetto

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	Un ID applicazione AAD a cui sono state concesse le autorizzazioni di accesso necessarie per Azure Key Vault che deve essere usato per crittografare i 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

Oggetto

Rappresenta le credenziali che possono essere utilizzate per connettersi a un'origine dati.

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

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

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

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

HighWaterMarkChangeDetectionPolicy

Oggetto

Definisce un criterio di rilevamento delle modifiche dei dati che acquisisce le modifiche in base al valore di una colonna di limite massimo.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Frammento di URI che specifica il tipo di criterio di rilevamento delle modifiche dei dati.
highWaterMarkColumnName	string	Il nome della colonna dell'alta marea.

IndexerPermissionOption

Enumerazione

Opzioni con vari tipi di dati di autorizzazione per l'indicizzazione.

Valore	Descrizione
userIds	Indicizzatore per inserire gli ID utente ACL dall'origine dati all'indice.
groupIds	Indicizzatore per inserire ACL groupIds dall'origine dati all'indice.
rbacScope	Indicizzatore per inserire l'ambito del controllo degli accessi in base al ruolo di Azure dall'origine dati all'indice.

NativeBlobSoftDeleteDeletionDetectionPolicy

Oggetto

Definisce un criterio di rilevamento dell'eliminazione dei dati usando la funzionalità di eliminazione temporanea nativa di Archiviazione BLOB di Azure per il rilevamento dell'eliminazione.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Frammento di URI che specifica il tipo di criterio di rilevamento dell'eliminazione dei dati.

SearchIndexerDataContainer

Oggetto

Rappresenta le informazioni sull'entità (ad esempio la tabella SQL di Azure o la raccolta CosmosDB) che verrà indicizzata.

Nome	Tipo	Descrizione
name	string	Nome della tabella o della vista (per l'origine dati SQL di Azure) o della raccolta (per l'origine dati CosmosDB) che verrà indicizzata.
query	string	Query applicata al contenitore di dati. La sintassi e il significato di questo parametro sono specifici dell'origine dati. Non supportato dalle origini dati SQL di Azure.

SearchIndexerDataNoneIdentity

Oggetto

Cancella la proprietà identity di un'origine dati.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Frammento di URI che specifica il tipo di identità.

SearchIndexerDataSource

Oggetto

Rappresenta una definizione dell'origine dati, che può essere utilizzata 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: NativeBlobSoftDeleteDeletionDetectionPolicy 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 ulteriore livello di crittografia dei dati inattivi per la definizione dell'origine dati quando si desidera avere la certezza completa che nessuno, nemmeno Microsoft, possa decrittografare la definizione dell'origine dati. Una volta crittografata, la definizione dell'origine dati rimarrà sempre crittografata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. È possibile modificare questa proprietà in base alle esigenze se si desidera ruotare la chiave di crittografia; La definizione dell'origine dati non sarà interessata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati a partire dal 1° gennaio 2019.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Un'identità gestita esplicita da utilizzare per l'origine dati. Se non viene specificata e la stringa di connessione è un'identità gestita, viene usata l'identità gestita assegnata dal sistema. Se non specificato, il valore rimane invariato. Se si specifica "none", il valore di questa proprietà viene cancellato.
indexerPermissionOptions	IndexerPermissionOption[]	Opzioni di acquisizione con vari tipi di dati di autorizzazione.
name	string	Nome dell'origine dati.
subType	string	Un tipo specifico di origine dati, nel caso in cui la risorsa sia in grado di utilizzare modalità diverse. Ad esempio, 'MongoDb' per determinati account 'cosmosDb'.
type	SearchIndexerDataSourceType	Tipo di origine dati.

SearchIndexerDataSourceType

Enumerazione

Definisce il tipo di un'origine dati.

Valore	Descrizione
azuresql	Indica un'origine dati SQL di Azure.
cosmosdb	Indica un'origine dati CosmosDB.
azureblob	Indica un'origine dati BLOB di Azure.
azuretable	Indica un'origine dati della tabella di Azure.
mysql	Indica un'origine dati MySql.
adlsgen2	Indica un'origine dati ADLS Gen2.
onelake	Indica un'origine dati Microsoft Fabric OneLake.

SearchIndexerDataUserAssignedIdentity

Oggetto

Specifica l'identità da utilizzare per un'origine dati.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Frammento di URI che specifica il tipo di identità.
userAssignedIdentity	string	L'ID risorsa di Azure completo di un'identità gestita assegnata all'utente, in genere nel formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" che avrebbe dovuto essere assegnato al servizio di ricerca.

SearchResourceEncryptionKey

Oggetto

Una chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite dall'utente possono essere utilizzate per crittografare o decrittografare i dati inattivi, ad esempio indici e mappe di sinonimi.

Nome	Tipo	Descrizione
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenziali facoltative di Azure Active Directory usate per l'accesso ad Azure Key Vault. Non necessario se si usa l'identità gestita.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Un'identità gestita esplicita da usare per questa chiave di crittografia. Se non viene specificata e la proprietà delle credenziali di accesso è null, viene usata l'identità gestita assegnata dal sistema. Al momento dell'aggiornamento della risorsa, se l'identità esplicita non è specificata, rimane invariata. Se si specifica "none", il valore di questa proprietà viene cancellato.
keyVaultKeyName	string	Nome della chiave di Azure Key Vault da usare per crittografare i dati inattivi.
keyVaultKeyVersion	string	Versione della chiave di Azure Key Vault da usare per crittografare i dati inattivi.
keyVaultUri	string	URI dell'insieme di credenziali delle chiavi 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

Oggetto

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 di "eliminazione temporanea" designata.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Frammento di URI che specifica il tipo di criterio di rilevamento dell'eliminazione dei dati.
softDeleteColumnName	string	Nome della colonna da utilizzare per il rilevamento dell'eliminazione temporanea.
softDeleteMarkerValue	string	Il valore dell'indicatore che identifica un elemento come eliminato.

SqlIntegratedChangeTrackingPolicy

Oggetto

Definisce un criterio di rilevamento delle modifiche dei dati che acquisisce le modifiche usando la funzionalità di rilevamento delle modifiche integrata del database SQL di Azure.

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