Data Sources - Create Or Update

Tjänst:: Search Service

API-version:: 2026-05-01-preview

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

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
dataSourceName	path	True	string	Namnet på datakällan.
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
ignoreResetRequirements	query		boolean	Ignorerar krav på cacheåterställning.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.
Accept		Accept	Acceptera-rubriken.
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 If-None-Match. Åtgärden utförs endast om ETag på servern inte matchar det här värdet.
Prefer	True	Prefer	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	Datacontainern för datakällan.
name	True	string	Namnet på datakällan.
type	True	SearchIndexerDataSourceType	Datakällans typ.
@odata.etag		string	ETag för datakällan.
credentials.connectionString		string	Anslutningssträngen för datakällan. 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.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Dataändringsidentifieringsprincipen för datakällan.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	Databorttagningsidentifieringsprincipen för datakällan.
description		string	Beskrivningen av datakällan.
encryptionKey		SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. 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 datakällans definition 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. Datakällans definition 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 det inte anges och anslutningssträngen är en hanterad identitet används den systemtilldelade hanterade identiteten. Om det inte 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	Begäran har slutförts.
201 Created	SearchIndexerDataSource	Begäran har slutförts och en ny resurs har skapats som ett resultat.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://search.azure.com/.default

Exempel

SearchServiceCreateOrUpdateDataSource

Exempelbegäran

HTTP

PUT https://previewexampleservice.search.windows.net/datasources('tempdatasource')?api-version=2026-05-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
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-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 som använder Azure Blob Storages inbyggda funktion för mjuk borttagning för borttagningsidentifiering.
Prefer	För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.
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 datakälladefinition 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 Key Vault. 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 funktionen Integrerad ändringsspårning i Azure SQL Database.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		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

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-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	Diskrimineringen för härledda typer.
highWaterMarkColumnName	string	Namnet på högvattenmärkeskolumnen.

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 som använder Azure Blob Storages inbyggda funktion för mjuk borttagning för borttagningsidentifiering.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Diskrimineringen för härledda typer.

Prefer

Uppräkning

För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.

Värde	Description
return=representation

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 datakälladefinition som kan användas för att konfigurera en indexerare.

Name	Typ	Description
@odata.etag	string	ETag för datakällan.
container	SearchIndexerDataContainer	Datacontainern för datakällan.
credentials.connectionString	string	Anslutningssträngen för datakällan. 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.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Dataändringsidentifieringsprincipen för datakällan.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	Databorttagningsidentifieringsprincipen för datakällan.
description	string	Beskrivningen av datakällan.
encryptionKey	SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. 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 datakällans definition 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. Datakällans definition 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 det inte anges och anslutningssträngen är en hanterad identitet används den systemtilldelade hanterade identiteten. Om det inte 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	Datakällans typ.

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.
sharepoint	Indikerar en SharePoint-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.
federatedIdentityClientId	string	Multi-tenant User-Assigned Managed Identity Support: Klient-ID:t för den multi-tentant-appen som har konfigurerats för att federera med den användartilldelade hanterade identiteten.
userAssignedIdentity	string	Det fullständigt kvalificerade Azure-resurs-ID:t för en användartilldelad hanterad identitet, vanligtvis i formuläret "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" som borde ha tilldelats söktjänsten.

SearchResourceEncryptionKey

Objekt

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

Name	Typ	Standardvärde	Description
accessCredentials.applicationId	string		Ett AAD-program-ID som har beviljats nödvändiga åtkomstbehörigheter till Azure Key Vault som ska användas när du krypterar dina data i vila. Program-ID:t bör inte förväxlas med objekt-ID:t för ditt AAD-program.
accessCredentials.applicationSecret	string		Autentiseringsnyckeln för det angivna AAD-programmet.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		En explicit hanterad identitet som ska användas för den här krypteringsnyckeln. Om det inte anges och egenskapen för åtkomstautentiseringsuppgifter är null används den systemtilldelade hanterade identiteten. Om den explicita identiteten är ospecificerad vid uppdatering av resursen förblir den oförändrad. Om "ingen" anges rensas värdet för den här egenskapen.
isServiceLevelKey	boolean	False	Ett valfritt värde som anger om denna nyckel är en servicenivånyckel. Standardvärdet är false.
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 Azure Key Vault-nyckeln som ska användas för att kryptera dina vilande data.
keyVaultUri	string		URI:n för ditt Azure Key Vault, även kallat DNS-namn, som innehåller nyckeln som ska användas för att kryptera dina data i vila. 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	Diskrimineringen för härledda typer.
softDeleteColumnName	string	Namnet på kolumnen som ska användas för identifiering av mjuk borttagning.
softDeleteMarkerValue	string	Det markörvärde som identifierar ett objekt som borttaget.

SqlIntegratedChangeTrackingPolicy

Objekt

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

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Diskrimineringen för härledda typer.