Partager via


Data Sources - Create

Crée une nouvelle source de données.

POST {endpoint}/datasources?api-version=2025-09-01

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string

URL du point de terminaison du service de recherche.

api-version
query True

string

Version de l’API cliente.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-request-id

string (uuid)

ID de suivi envoyé avec la demande pour aider au débogage.

Corps de la demande

Nom Obligatoire Type Description
container True

SearchIndexerDataContainer

Conteneur de données de la source de données.

credentials True

DataSourceCredentials

Informations d’identification de la source de données.

name True

string

Nom de la source de données.

type True

SearchIndexerDataSourceType

Type de source de données.

@odata.etag

string

ETag de la source de données.

dataChangeDetectionPolicy DataChangeDetectionPolicy:

Stratégie de détection des modifications de données pour la source de données.

dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

SoftDeleteColumnDeletionDetectionPolicy

Stratégie de détection de suppression des données pour la source de données.

description

string

Description de la source de données.

encryptionKey

SearchResourceEncryptionKey

Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour votre définition de source de données lorsque vous voulez avoir l’assurance totale que personne, pas même Microsoft, ne peut déchiffrer votre définition de source de données. Une fois que vous avez chiffré la définition de votre source de données, celle-ci reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; La définition de votre source de données n’est pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.

Réponses

Nom Type Description
201 Created

SearchIndexerDataSource

Other Status Codes

ErrorResponse

Réponse d’erreur.

Exemples

SearchServiceCreateDataSource

Exemple de requête

POST https://stableexampleservice.search.windows.net/datasources?api-version=2025-09-01


{
  "name": "tempdatasource",
  "description": "My Azure Blob data source.",
  "type": "azureblob",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "doc-extraction-skillset",
    "query": "E2E_Dsat"
  },
  "dataChangeDetectionPolicy": {
    "highWaterMarkColumnName": "metadata_storage_last_modified",
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy"
  },
  "dataDeletionDetectionPolicy": {
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true",
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy"
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

Exemple de réponse

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempdatasource",
  "description": "My Azure Blob data source.",
  "type": "azureblob",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "doc-extraction-skillset",
    "query": "E2E_Dsat"
  },
  "dataChangeDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
    "highWaterMarkColumnName": "metadata_storage_last_modified"
  },
  "dataDeletionDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true"
  }
}

Définitions

Nom Description
AzureActiveDirectoryApplicationCredentials

Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.

DataSourceCredentials

Représente les informations d’identification qui peuvent être utilisées pour se connecter à une source de données.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

HighWaterMarkChangeDetectionPolicy

Définit une stratégie de détection des modifications de données qui capture les modifications en fonction de la valeur d’une colonne de limite supérieure.

SearchIndexerDataContainer

Représente des informations sur l’entité (telle qu’une table Azure SQL ou une collection CosmosDB) qui sera indexée.

SearchIndexerDataSource

Représente une définition de source de données, qui peut être utilisée pour configurer un indexeur.

SearchIndexerDataSourceType

Définit le type d’une source de données.

SearchResourceEncryptionKey

Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos, telles que des index et des cartes de synonymes.

SoftDeleteColumnDeletionDetectionPolicy

Définit une stratégie de détection de suppression des données qui implémente une stratégie de suppression réversible. Il détermine si un élément doit être supprimé en fonction de la valeur d’une colonne « suppression réversible » désignée.

SqlIntegratedChangeTrackingPolicy

Définit une stratégie de détection des modifications de données qui capture les modifications à l’aide de la fonctionnalité de suivi des modifications intégré d’Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.

Nom Type Description
applicationId

string

ID d’application AAD qui a reçu les autorisations d’accès requises à Azure Key Vault à utiliser lors du chiffrement de vos données au repos. L’ID d’application ne doit pas être confondu avec l’ID d’objet de votre application AAD.

applicationSecret

string

Clé d’authentification de l’application AAD spécifiée.

DataSourceCredentials

Représente les informations d’identification qui peuvent être utilisées pour se connecter à une source de données.

Nom Type Description
connectionString

string

Chaîne de connexion pour la source de données. Pour Azure SQL, Azure Blob, ADLS Gen 2 et Azure Table, il s’agit de la chaîne de connexion ou de l’ID de ressource si vous utilisez l’identité managée. Pour CosmosDB, il s’agit d’une chaîne de connexion formatée spécifiant ApiKind ou l’ID de ressource pour l’identité managée. Pour les fichiers Onelake, la chaîne de connexion est le GUID de l’espace de travail ou le nom de domaine complet de l’espace de travail. Onelake ne prend en charge que les connexions d’identité gérées. Définissez la valeur ( <unchanged> avec crochets) si vous ne souhaitez pas que la chaîne de connexion soit mise à jour. Définissez la valeur sur <redacted> si vous souhaitez supprimer la valeur de la chaîne de connexion de la source de données.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

HighWaterMarkChangeDetectionPolicy

Définit une stratégie de détection des modifications de données qui capture les modifications en fonction de la valeur d’une colonne de limite supérieure.

Nom Type Description
@odata.type string:

#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy

Fragment d’URI spécifiant le type de stratégie de détection des modifications de données.

highWaterMarkColumnName

string

Nom de la colonne de la ligne des hautes eaux.

SearchIndexerDataContainer

Représente des informations sur l’entité (telle qu’une table Azure SQL ou une collection CosmosDB) qui sera indexée.

Nom Type Description
name

string

Nom de la table ou de la vue (pour la source de données SQL Azure), de la collection (pour la source de données CosmosDB), du conteneur (pour les sources de données Blob Azure et ADLS Gen 2), de la table Azure (pour la source de données Table Azure) ou du lakehouse (pour la source de données Onelake) qui sera indexée.

query

string

Requête appliquée à ce conteneur de données. Pour CosmosDB, la requête de source de données peut aplatir et filtrer les données. Pour Azure Blob et ADLS Gen 2, les requêtes peuvent être filtrées par dossiers. Pour Azure Table, la requête peut filtrer par données de ligne. Pour Onelake, la requête peut filtrer par dossier ou raccourci. Non pris en charge par les sources de données SQL Azure.

SearchIndexerDataSource

Représente une définition de source de données, qui peut être utilisée pour configurer un indexeur.

Nom Type Description
@odata.etag

string

ETag de la source de données.

container

SearchIndexerDataContainer

Conteneur de données de la source de données.

credentials

DataSourceCredentials

Informations d’identification de la source de données.

dataChangeDetectionPolicy DataChangeDetectionPolicy:

Stratégie de détection des modifications de données pour la source de données.

dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

SoftDeleteColumnDeletionDetectionPolicy

Stratégie de détection de suppression des données pour la source de données.

description

string

Description de la source de données.

encryptionKey

SearchResourceEncryptionKey

Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour votre définition de source de données lorsque vous voulez avoir l’assurance totale que personne, pas même Microsoft, ne peut déchiffrer votre définition de source de données. Une fois que vous avez chiffré la définition de votre source de données, celle-ci reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; La définition de votre source de données n’est pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.

name

string

Nom de la source de données.

type

SearchIndexerDataSourceType

Type de source de données.

SearchIndexerDataSourceType

Définit le type d’une source de données.

Valeur Description
azuresql

Définition d’une source de données SQL Azure dont les informations d’identification peuvent être une chaîne de connexion SQL standard ou le ResourceId de la ressource SQL. La propriété container fait référence à la table ou à la vue à indexer. Le paramètre de requête n’est pas pris en charge pour cette source de données.

cosmosdb

Définition d’une source de données CosmosDB dont les informations d’identification peuvent être une chaîne de connexion formatée contenant des détails pour AccountEndpoint, AccountKey et Database pour une connexion basée sur une clé, ou des détails pour ResourceID et ApiKind pour une connexion sans clé. La propriété container fait référence à la collection cosmosdb à indexer et la propriété de requête facultative fait référence à une requête SQL sur la collection.

azureblob

Définition d’une source de données Blob Azure dont les informations d’identification peuvent être une chaîne de connexion de stockage ou le ResourceId du compte de stockage. La propriété container fait référence au conteneur d’objets blob à indexer et la propriété de requête facultative fait référence à un sous-dossier spécifique du conteneur.

azuretable

Définition d’une source de données de table Azure dont les informations d’identification peuvent être une chaîne de connexion de table ou le ResourceId du compte de stockage. La propriété container fait référence au conteneur d’objets blob à indexer et la propriété de requête facultative peut être utilisée pour filtrer les lignes.

mysql

Définition d’une source de données SQL Azure dont les informations d’identification peuvent être une chaîne de connexion SQL standard ADO.NET formatée ou le ResourceId de la ressource SQL. La propriété container fait référence à la table ou à la vue à indexer. Le paramètre de requête n’est pas pris en charge pour cette source de données.

adlsgen2

Définition d’une source de données Azure ADLS Gen 2 dont les informations d’identification peuvent être une chaîne de connexion de stockage ou le ResourceId du compte de stockage. La propriété container fait référence au conteneur d’objets blob à indexer et la propriété de requête facultative fait référence à un sous-dossier spécifique du conteneur.

onelake

Définition d’une source de données Microsoft Fabric Onelake dont les informations d’identification peuvent être le GUID de l’espace de travail Fabric ou un nom de domaine complet de l’espace de travail. La propriété container fait référence au GUID lakehouse et la propriété de requête facultative fait référence aux dossiers ou aux raccourcis dans lakehouse.

SearchResourceEncryptionKey

Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos, telles que des index et des cartes de synonymes.

Nom Type Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Informations d’identification Azure Active Directory facultatives utilisées pour accéder à votre coffre de clés Azure. Non requis si vous utilisez l’identité managée à la place.

keyVaultKeyName

string

Nom de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.

keyVaultKeyVersion

string

Version de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.

keyVaultUri

string

URI de votre Azure Key Vault, également appelé nom DNS, qui contient la clé à utiliser pour chiffrer vos données au repos. Un exemple d’URI pourrait être https://my-keyvault-name.vault.azure.net.

SoftDeleteColumnDeletionDetectionPolicy

Définit une stratégie de détection de suppression des données qui implémente une stratégie de suppression réversible. Il détermine si un élément doit être supprimé en fonction de la valeur d’une colonne « suppression réversible » désignée.

Nom Type Description
@odata.type string:

#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy

Fragment d’URI spécifiant le type de stratégie de détection de suppression des données.

softDeleteColumnName

string

Nom de la colonne à utiliser pour la détection de suppression réversible.

softDeleteMarkerValue

string

Valeur de marqueur qui identifie un élément comme supprimé.

SqlIntegratedChangeTrackingPolicy

Définit une stratégie de détection des modifications de données qui capture les modifications à l’aide de la fonctionnalité de suivi des modifications intégré d’Azure SQL Database.

Nom Type Description
@odata.type string:

#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy

Fragment d’URI spécifiant le type de stratégie de détection des modifications de données.