Data Sources - Create Or Update

Tjänst:: Search Service

API-version:: 2025-08-01-preview

Skapar en ny datakälla eller uppdaterar en datakälla om den redan finns.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
dataSourceName	path	True	string	Namnet på den datakälla som ska skapas eller uppdateras.
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
api-version	query	True	string	Klient-API-version.
ignoreResetRequirements	query		boolean	Ignorerar krav på cacheåterställning.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Spårnings-ID:t som skickades med begäran för att hjälpa till med felsökning.
If-Match		string	Definierar villkoret If-Match. Åtgärden utförs endast om ETag på servern matchar det här värdet.
If-None-Match		string	Definierar villkoret Om-None-Match. Åtgärden utförs endast om ETag på servern inte matchar det här värdet.
Prefer	True	string	För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.

Begärandetext

Name	Obligatorisk	Typ	Description
container	True	SearchIndexerDataContainer	Databehållaren för datakällan.
credentials	True	DataSourceCredentials	Autentiseringsuppgifter för datakällan.
name	True	string	Namnet på datakällan.
type	True	SearchIndexerDataSourceType	Typen av datakälla.
@odata.etag		string	ETag för datakällan.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Principen för identifiering av dataändringar för datakällan.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy NativeBlobSoftDeleteDeletionDetectionPolicy	Principen för identifiering av databorttagning för datakällan.
description		string	Beskrivning av datakällan.
encryptionKey		SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för din datakällsdefinition när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera din datakällsdefinition. När du har krypterat definitionen av datakällan förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Definitionen av datakällan påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
identity		SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	En explicit hanterad identitet som ska användas för den här datakällan. Om inget anges och συμβολοσειρά σύνδεσης är en hanterad identitet används den system tilldelade hanterade identiteten. Om inget anges förblir värdet oförändrat. Om "ingen" anges rensas värdet för den här egenskapen.
indexerPermissionOptions		IndexerPermissionOption[]	Inmatningsalternativ med olika typer av behörighetsdata.

Svar

Name	Typ	Description
200 OK	SearchIndexerDataSource
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Felsvar.

Exempel

SearchServiceCreateOrUpdateDataSource

Exempelbegäran

HTTP

PUT https://previewexampleservice.search.windows.net/datasources('tempdatasource')?api-version=2025-08-01-preview&ignoreResetRequirements=





{
  "name": "tempdatasource",
  "description": "My Azure Adls Gen2 data source with ACLs.",
  "type": "adlsgen2",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "adls-gen2-doc-extraction-acl",
    "query": "folder_has_final_acl"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  },
  "indexerPermissionOptions": [
    "userIds",
    "groupIds",
    "rbacScope"
  ],
  "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"
}

Exempelsvar

Statuskod:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempdatasource",
  "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"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  }
}

Statuskod:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempdatasource",
  "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"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  }
}

Definitioner

Name	Description
AzureActiveDirectoryApplicationCredentials	Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.
DataSourceCredentials	Representerar autentiseringsuppgifter som kan användas för att ansluta till en datakälla.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HighWaterMarkChangeDetectionPolicy	Definierar en princip för identifiering av dataändringar som samlar in ändringar baserat på värdet för en högvattenmärkeskolumn.
IndexerPermissionOption	Alternativ med olika typer av behörighetsdata att indexera.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definierar en princip för identifiering av databorttagning med hjälp av Azure Blob Storage inbyggda funktion för mjuk borttagning för borttagningsidentifiering.
SearchIndexerDataContainer	Representerar information om entiteten (till exempel Azure SQL-tabellen eller CosmosDB-samlingen) som ska indexeras.
SearchIndexerDataNoneIdentity	Rensar identitetsegenskapen för en datakälla.
SearchIndexerDataSource	Representerar en definition av en datakälla som kan användas för att konfigurera en indexerare.
SearchIndexerDataSourceType	Definierar typen av datakälla.
SearchIndexerDataUserAssignedIdentity	Anger identiteten för en datakälla som ska användas.
SearchResourceEncryptionKey	En kundhanterad krypteringsnyckel i Azure 密钥保管库. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymmappningar.
SoftDeleteColumnDeletionDetectionPolicy	Definierar en princip för identifiering av databorttagning som implementerar en strategi för mjuk borttagning. Den avgör om ett objekt ska tas bort baserat på värdet för en angiven kolumn för mjuk borttagning.
SqlIntegratedChangeTrackingPolicy	Definierar en princip för identifiering av dataändringar som samlar in ändringar med hjälp av funktionen Integrerad ändringsspårning i Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Objekt

Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.

Name	Typ	Description
applicationId	string	Ett AAD-program-ID som har beviljats de åtkomstbehörigheter som krävs för att Azure Key Vault ska användas när du krypterar dina vilande data. Program-ID:t ska inte förväxlas med objekt-ID:t för ditt AAD-program.
applicationSecret	string	Autentiseringsnyckeln för det angivna AAD-programmet.

DataSourceCredentials

Objekt

Representerar autentiseringsuppgifter som kan användas för att ansluta till en datakälla.

Name	Typ	Description
connectionString	string	Συμβολοσειρά Ange till `<unchanged>` (med hakparenteser) om du inte vill att συμβολοσειρά σύνδεσης Ange till `<redacted>` om du vill ta bort värdet för anslutningssträngen från datakällan.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HighWaterMarkChangeDetectionPolicy

Objekt

Definierar en princip för identifiering av dataändringar som samlar in ändringar baserat på värdet för en högvattenmärkeskolumn.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Ett URI-fragment som anger typen av princip för identifiering av dataändringar.
highWaterMarkColumnName	string	Namnet på högvattenmärkets kolumn.

IndexerPermissionOption

Uppräkning

Alternativ med olika typer av behörighetsdata att indexera.

Värde	Description
userIds	Indexerare för att mata in ACL userIds från datakälla till index.
groupIds	Indexerare för att mata in ACL groupIds från datakälla till index.
rbacScope	Indexerare för att mata in Azure RBAC-omfång från datakälla till index.

NativeBlobSoftDeleteDeletionDetectionPolicy

Objekt

Definierar en princip för identifiering av databorttagning med hjälp av Azure Blob Storage inbyggda funktion för mjuk borttagning för borttagningsidentifiering.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Ett URI-fragment som anger typen av princip för identifiering av databorttagning.

SearchIndexerDataContainer

Objekt

Representerar information om entiteten (till exempel Azure SQL-tabellen eller CosmosDB-samlingen) som ska indexeras.

Name	Typ	Description
name	string	Namnet på tabellen eller vyn (för Azure SQL-datakälla) eller samlingen (för CosmosDB-datakällan) som ska indexeras.
query	string	En fråga som tillämpas på den här datacontainern. Syntaxen och innebörden av den här parametern är specifik för datakällan. Stöds inte av Azure SQL datakällor.

SearchIndexerDataNoneIdentity

Objekt

Rensar identitetsegenskapen för en datakälla.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Ett URI-fragment som anger typen av identitet.

SearchIndexerDataSource

Objekt

Representerar en definition av en datakälla som kan användas för att konfigurera en indexerare.

Name	Typ	Description
@odata.etag	string	ETag för datakällan.
container	SearchIndexerDataContainer	Databehållaren för datakällan.
credentials	DataSourceCredentials	Autentiseringsuppgifter för datakällan.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Principen för identifiering av dataändringar för datakällan.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	Principen för identifiering av databorttagning för datakällan.
description	string	Beskrivning av datakällan.
encryptionKey	SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för din datakällsdefinition när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera din datakällsdefinition. När du har krypterat definitionen av datakällan förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Definitionen av datakällan påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	En explicit hanterad identitet som ska användas för den här datakällan. Om inget anges och συμβολοσειρά σύνδεσης är en hanterad identitet används den system tilldelade hanterade identiteten. Om inget anges förblir värdet oförändrat. Om "ingen" anges rensas värdet för den här egenskapen.
indexerPermissionOptions	IndexerPermissionOption[]	Inmatningsalternativ med olika typer av behörighetsdata.
name	string	Namnet på datakällan.
subType	string	En specifik typ av datakälla, om resursen kan användas på olika sätt. Till exempel "MongoDb" för vissa "cosmosDb"-konton.
type	SearchIndexerDataSourceType	Typen av datakälla.

SearchIndexerDataSourceType

Uppräkning

Definierar typen av datakälla.

Värde	Description
azuresql	Anger en Azure SQL datakälla.
cosmosdb	Anger en CosmosDB-datakälla.
azureblob	Anger en Azure Blob-datakälla.
azuretable	Anger en Azure Table-datakälla.
mysql	Anger en MySql-datakälla.
adlsgen2	Anger en ADLS Gen2-datakälla.
onelake	Anger en Microsoft Fabric OneLake-datakälla.

SearchIndexerDataUserAssignedIdentity

Objekt

Anger identiteten för en datakälla som ska användas.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ett URI-fragment som anger typen av identitet.
userAssignedIdentity	string	Det fullständigt kvalificerade Azure-resurs-ID:t för en användartilldelad hanterad identitet, vanligtvis i formatet "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" som skulle ha tilldelats till söktjänsten.

SearchResourceEncryptionKey

Objekt

En kundhanterad krypteringsnyckel i Azure 密钥保管库. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymmappningar.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Valfria Azure Active Directory-autentiseringsuppgifter som används för att komma åt din Azure Key Vault. Krävs inte om du använder hanterad identitet i stället.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	En explicit hanterad identitet som ska användas för den här krypteringsnyckeln. Om inget anges och egenskapen för autentiseringsuppgifter för åtkomst är null används den system tilldelade hanterade identiteten. Vid uppdatering av resursen, om den explicita identiteten är ospecificerad, förblir den oförändrad. Om "ingen" anges rensas värdet för den här egenskapen.
keyVaultKeyName	string	Namnet på din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data.
keyVaultKeyVersion	string	Den version av din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data.
keyVaultUri	string	URI:n för din Azure Key Vault, även kallat DNS-namn, som innehåller nyckeln som ska användas för att kryptera dina vilande data. Ett exempel på en URI kan vara `https://my-keyvault-name.vault.azure.net`.

SoftDeleteColumnDeletionDetectionPolicy

Objekt

Definierar en princip för identifiering av databorttagning som implementerar en strategi för mjuk borttagning. Den avgör om ett objekt ska tas bort baserat på värdet för en angiven kolumn för mjuk borttagning.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Ett URI-fragment som anger typen av princip för identifiering av databorttagning.
softDeleteColumnName	string	Namnet på kolumnen som ska användas för identifiering av mjuk borttagning.
softDeleteMarkerValue	string	Markörvärdet som identifierar ett objekt som borttaget.

SqlIntegratedChangeTrackingPolicy

Objekt

Definierar en princip för identifiering av dataändringar som samlar in ändringar med hjälp av funktionen Integrerad ändringsspårning i Azure SQL Database.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Ett URI-fragment som anger typen av princip för identifiering av dataändringar.