Data Sources - Get

Servicio:: Search Service

Versión de la API:: 2025-08-01-preview

Recupera una definición de origen de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataSourceName	path	True	string	El nombre de la fuente de datos que se va a recuperar.
endpoint	path	True	string	La dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string	Versión de la API del cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	El identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre	Tipo	Description
200 OK	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

SearchServiceGetDataSource

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
AzureActiveDirectoryApplicationCredentials	Credenciales de una aplicación registrada creada para el servicio de búsqueda, usadas para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault.
DataSourceCredentials	Representa las credenciales que se pueden usar para conectarse a un origen de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
HighWaterMarkChangeDetectionPolicy	Define una directiva de detección de cambios de datos que captura los cambios en función del valor de una columna de límite superior.
IndexerPermissionOption	Opciones con varios tipos de datos de permisos para indexar.
NativeBlobSoftDeleteDeletionDetectionPolicy	Define una directiva de detección de eliminación de datos mediante la característica de eliminación temporal nativa de Azure Blob Storage para la detección de eliminación.
SearchIndexerDataContainer	Representa información sobre la entidad (como la tabla de Azure SQL o la colección de CosmosDB) que se indexará.
SearchIndexerDataNoneIdentity	Borra la propiedad de identidad de un origen de datos.
SearchIndexerDataSource	Representa una definición de origen de datos, que se puede usar para configurar un indexador.
SearchIndexerDataSourceType	Define el tipo de origen de datos.
SearchIndexerDataUserAssignedIdentity	Especifica la identidad de un origen de datos que se va a utilizar.
SearchResourceEncryptionKey	Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos.
SoftDeleteColumnDeletionDetectionPolicy	Define una directiva de detección de eliminación de datos que implementa una estrategia de eliminación temporal. Determina si un elemento debe eliminarse en función del valor de una columna de "eliminación temporal" designada.
SqlIntegratedChangeTrackingPolicy	Define una directiva de detección de cambios de datos que captura los cambios mediante la característica de seguimiento de cambios integrado de Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Objeto

Credenciales de una aplicación registrada creada para el servicio de búsqueda, usadas para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault.

Nombre	Tipo	Description
applicationId	string	Un identificador de aplicación de AAD al que se concedieron los permisos de acceso necesarios a Azure Key Vault que se usará al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el identificador de objeto de la aplicación de AAD.
applicationSecret	string	Clave de autenticación de la aplicación de AAD especificada.

DataSourceCredentials

Objeto

Representa las credenciales que se pueden usar para conectarse a un origen de datos.

Nombre	Tipo	Description
connectionString	string	Cadena de conexión del origen de datos. Establézcalo en `<unchanged>` (con corchetes) si no desea que se actualice la cadena de conexión. Establézcalo en `<redacted>` si desea quitar el valor de la cadena de conexión del origen de datos.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

HighWaterMarkChangeDetectionPolicy

Objeto

Define una directiva de detección de cambios de datos que captura los cambios en función del valor de una columna de límite superior.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Un fragmento de URI que especifica el tipo de política de detección de cambios de datos.
highWaterMarkColumnName	string	El nombre de la columna de marca de límite superior.

IndexerPermissionOption

Enumeración

Opciones con varios tipos de datos de permisos para indexar.

Valor	Description
userIds	Indexador para ingerir userIds de ACL del origen de datos al índice.
groupIds	Indexador para ingerir groupIds de ACL desde el origen de datos al índice.
rbacScope	Indexador para ingerir el ámbito RBAC de Azure del origen de datos al índice.

NativeBlobSoftDeleteDeletionDetectionPolicy

Objeto

Define una directiva de detección de eliminación de datos mediante la característica de eliminación temporal nativa de Azure Blob Storage para la detección de eliminación.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Un fragmento de URI que especifica el tipo de directiva de detección de eliminación de datos.

SearchIndexerDataContainer

Objeto

Representa información sobre la entidad (como la tabla de Azure SQL o la colección de CosmosDB) que se indexará.

Nombre	Tipo	Description
name	string	Nombre de la tabla o vista (para el origen de datos SQL de Azure) o la colección (para el origen de datos de CosmosDB) que se indexará.
query	string	Consulta que se aplica a este contenedor de datos. La sintaxis y el significado de este parámetro son específicos de la fuente de datos. No es compatible con los orígenes de datos de Azure SQL.

SearchIndexerDataNoneIdentity

Objeto

Borra la propiedad de identidad de un origen de datos.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragmento de URI que especifica el tipo de identidad.

SearchIndexerDataSource

Objeto

Representa una definición de origen de datos, que se puede usar para configurar un indexador.

Nombre	Tipo	Description
@odata.etag	string	La ETag de la fuente de datos.
container	SearchIndexerDataContainer	El contenedor de datos para el origen de datos.
credentials	DataSourceCredentials	Credenciales para el origen de datos.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	La política de detección de cambios de datos para el origen de datos.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	La política de detección de eliminación de datos para el origen de datos.
description	string	La descripción de la fuente de datos.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para la definición del origen de datos cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrar la definición del origen de datos. Una vez que haya cifrado la definición de la fuente de datos, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar su clave de cifrado; La definición de la fuente de datos no se verá afectada. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios pagos creados a partir del 1 de enero de 2019.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Una identidad administrada explícita que se usará para este origen de datos. Si no se especifica y la cadena de conexión es una identidad administrada, se usa la identidad administrada asignada por el sistema. Si no se especifica, el valor permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad.
indexerPermissionOptions	IndexerPermissionOption[]	Opciones de ingesta con varios tipos de datos de permisos.
name	string	El nombre de la fuente de datos.
subType	string	Un tipo específico de origen de datos, en caso de que el recurso sea capaz de diferentes modalidades. Por ejemplo, 'MongoDb' para ciertas cuentas 'cosmosDb'.
type	SearchIndexerDataSourceType	El tipo de origen de datos.

SearchIndexerDataSourceType

Enumeración

Define el tipo de origen de datos.

Valor	Description
azuresql	Indica un origen de datos de Azure SQL.
cosmosdb	Indica un origen de datos de CosmosDB.
azureblob	Indica un origen de datos de Azure Blob.
azuretable	Indica un origen de datos de tabla de Azure.
mysql	Indica un origen de datos MySql.
adlsgen2	Indica un origen de datos de ADLS Gen2.
onelake	Indica un origen de datos de Microsoft Fabric OneLake.

SearchIndexerDataUserAssignedIdentity

Objeto

Especifica la identidad de un origen de datos que se va a utilizar.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragmento de URI que especifica el tipo de identidad.
userAssignedIdentity	string	Identificador de recurso completo de Azure de una identidad administrada asignada por el usuario, normalmente con el formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que debería haberse asignado al servicio de búsqueda.

SearchResourceEncryptionKey

Objeto

Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos.

Nombre	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciales opcionales de Azure Active Directory usadas para acceder a Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Una identidad administrada explícita que se usará para esta clave de cifrado. Si no se especifica y la propiedad de credenciales de acceso es null, se usa la identidad administrada asignada por el sistema. Al actualizar el recurso, si no se especifica la identidad explícita, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad.
keyVaultKeyName	string	Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.
keyVaultKeyVersion	string	La versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.
keyVaultUri	string	El URI de Azure Key Vault, también conocido como nombre DNS, que contiene la clave que se usará para cifrar los datos en reposo. Un ejemplo de URI podría ser `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Objeto

Define una directiva de detección de eliminación de datos que implementa una estrategia de eliminación temporal. Determina si un elemento debe eliminarse en función del valor de una columna de "eliminación temporal" designada.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Un fragmento de URI que especifica el tipo de directiva de detección de eliminación de datos.
softDeleteColumnName	string	El nombre de la columna que se va a usar para la detección de eliminación temporal.
softDeleteMarkerValue	string	Valor de marcador que identifica un elemento como eliminado.

SqlIntegratedChangeTrackingPolicy

Objeto

Define una directiva de detección de cambios de datos que captura los cambios mediante la característica de seguimiento de cambios integrado de Azure SQL Database.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Un fragmento de URI que especifica el tipo de política de detección de cambios de datos.