Data Sources - Create

Servicio:: Search Service

Versión de la API:: 2023-11-01

Crea un nuevo origen de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
container	True	SearchIndexerDataContainer	Contenedor de datos para el origen de datos.
credentials	True	DataSourceCredentials	Credenciales para el origen de datos.
name	True	string	Nombre del origen de datos.
type	True	SearchIndexerDataSourceType	Tipo del origen de datos.
@odata.etag		string	ETag del origen de datos.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Directiva de detección de cambios de datos para el origen de datos.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Directiva de detección de eliminación de datos para el origen de datos.
description		string	Descripción del origen 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 quiere asegurarse de que nadie, ni siquiera Microsoft, puede descifrar la definición del origen de datos. Una vez que haya cifrado la definición del origen 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 la clave de cifrado; La definición del origen 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 de pago creados el 1 de enero de 2019 o después.

Respuestas

Nombre	Tipo	Description
201 Created	SearchIndexerDataSource
Other Status Codes	SearchError	Respuesta de error.

Ejemplos

SearchServiceCreateDataSource

Solicitud de ejemplo

HTTP

POST https://myservice.search.windows.net/datasources?api-version=2023-11-01

{
  "name": "mydocdbdatasource",
  "description": "My Cosmos DB data source.",
  "type": "cosmosdb",
  "credentials": {
    "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId"
  },
  "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": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "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": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

Definiciones

Nombre	Description
AzureActiveDirectoryApplicationCredentials	Credenciales de una aplicación registrada creada para el servicio de búsqueda, que se usa 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.
HighWaterMarkChangeDetectionPolicy	Define una directiva de detección de cambios de datos que captura los cambios en función del valor de una columna de marca de agua alta.
SearchError	Describe una condición de error para la API.
SearchIndexerDataContainer	Representa información sobre la entidad (como la tabla de Azure SQL o la colección cosmosDB) que se indexará.
SearchIndexerDataSource	Representa una definición de origen de datos, que se puede usar para configurar un indexador.
SearchIndexerDataSourceType	Define el tipo de un origen de datos.
SearchResourceEncryptionKey	Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que cree y administre se pueden usar para cifrar o descifrar datos en reposo en el servicio de búsqueda, 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 se debe eliminar en función del valor de una columna designada "eliminación temporal".
SqlIntegratedChangeTrackingPolicy	Define una directiva de detección de cambios de datos que captura los cambios mediante la característica Seguimiento de cambios integrado de Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Objeto

Credenciales de una aplicación registrada creada para el servicio de búsqueda, que se usa 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 va a usar al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el id. 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 para el origen de datos. Establezca en `<unchanged>` (con corchetes) si no desea actualizar la cadena de conexión. Establezca en `<redacted>` si desea quitar el valor de la cadena de conexión del origen de datos.

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 marca de agua alta.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Fragmento de URI que especifica el tipo de directiva de detección de cambios de datos.
highWaterMarkColumnName	string	Nombre de la columna de marca de agua alta.

SearchError

Objeto

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.

SearchIndexerDataContainer

Objeto

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

Nombre	Tipo	Description
name	string	Nombre de la tabla o vista (para el origen de datos de Azure SQL) 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íficas del origen de datos. No es compatible con los orígenes de datos de Azure SQL.

SearchIndexerDataSource

Objeto

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

Nombre	Tipo	Description
@odata.etag	string	ETag del origen de datos.
container	SearchIndexerDataContainer	Contenedor de datos para el origen de datos.
credentials	DataSourceCredentials	Credenciales para el origen de datos.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Directiva de detección de cambios de datos para el origen de datos.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	Directiva de detección de eliminación de datos para el origen de datos.
description	string	Descripción del origen 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 quiere asegurarse de que nadie, ni siquiera Microsoft, puede descifrar la definición del origen de datos. Una vez que haya cifrado la definición del origen 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 la clave de cifrado; La definición del origen 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 de pago creados el 1 de enero de 2019 o después.
name	string	Nombre del origen de datos.
type	SearchIndexerDataSourceType	Tipo del origen de datos.

SearchIndexerDataSourceType

Enumeración

Define el tipo de un 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 Blob de Azure.
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.

SearchResourceEncryptionKey

Objeto

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

Nombre	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciales opcionales de Azure Active Directory que se usan para acceder a Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar.
keyVaultKeyName	string	Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.
keyVaultKeyVersion	string	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 denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un URI de ejemplo 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 se debe eliminar en función del valor de una columna designada "eliminación temporal".

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Fragmento de URI que especifica el tipo de directiva de detección de eliminación de datos.
softDeleteColumnName	string	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 Seguimiento de cambios integrado de Azure SQL Database.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Fragmento de URI que especifica el tipo de directiva de detección de cambios de datos.