Dela via

Data Sources - Create

Tjänst:
Search Service
API-version:
2025-09-01

Skapar en ny datakälla.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

Slutpunkts-URL:en för söktjänsten.
api-version
 query True

string

Klient-API-version.

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.

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:

Principen för identifiering av dataändringar för datakällan.
dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

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.

Svar

Name Typ Description
201 Created

SearchIndexerDataSource

Other Status Codes

ErrorResponse

Felsvar.

Exempel

SearchServiceCreateDataSource

Exempelbegäran

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"
}

Exempelsvar

Statuskod:
201 
{
  "@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"
  }
}

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.
SearchIndexerDataContainer

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

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

Definierar typen av datakälla.
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

Συμβολοσειρά För Azure SQL, Azure Blob, ADLS Gen 2 och Azure Table skulle detta vara συμβολοσειρά σύνδεσης eller resurs-ID om du använder hanterad identitet. För CosmosDB skulle detta vara en formaterad συμβολοσειρά σύνδεσης som anger ApiKind eller resurs-ID för hanterad identitet. För Onelake-filer skulle συμβολοσειρά σύνδεσης vara antingen arbetsytans GUID eller arbetsytans FQDN. Onelake stöder endast anslutningar med hanterade identiteter. 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.

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), samlingen (för CosmosDB-datakällan), containern (för Azure Blob- och ADLS Gen 2-datakällor), Azure Table (för Azure Table-datakällan) eller lakehouse (för Onelake-datakällan) som ska indexeras.
query

string

En fråga som tillämpas på den här datacontainern. För CosmosDB kan datakällans fråga platta ut och filtrera data. För Azure Blob och ADLS Gen 2 kan frågan filtrera efter mappar. För Azure Table kan frågan filtrera efter raddata. För Onelake kan frågan filtrera efter mapp eller genväg. Stöds inte av Azure SQL datakällor.

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:

Principen för identifiering av dataändringar för datakällan.
dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

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.
name

string

Namnet på datakällan.
type

SearchIndexerDataSourceType

Typen av datakälla.

SearchIndexerDataSourceType

Uppräkning

Definierar typen av datakälla.

Värde Description
azuresql

Definition av en Azure SQL-datakälla vars autentiseringsuppgifter antingen kan vara en standard-SQL-anslutningssträng eller ResourceId för SQL-resursen. Egenskapen container refererar till den tabell eller vy som ska indexeras. Frågeparametern stöds inte för den här datakällan.
cosmosdb

Definition av en CosmosDB-datakälla vars autentiseringsuppgifter antingen kan vara en formaterad συμβολοσειρά σύνδεσης som innehåller information om AccountEndpoint, AccountKey och Database för en nyckelbaserad anslutning eller information om ResourceID och ApiKind för nyckellös anslutning. Containeregenskapen refererar till cosmosdb-samlingen som ska indexeras och den valfria frågeegenskapen refererar till en SQL-fråga i samlingen.
azureblob

Definition av en Azure Blob-datakälla vars autentiseringsuppgifter antingen kan vara en lagringsanslutningssträng eller ResourceId för lagringskontot. Containeregenskapen refererar till blobcontainern som ska indexeras och den valfria frågeegenskapen refererar till en specifik undermapp i containern.
azuretable

Definition av en Azure Table-datakälla vars autentiseringsuppgifter antingen kan vara en tabellanslutningssträng eller ResourceId för lagringskontot. Containeregenskapen refererar till blobcontainern som ska indexeras och den valfria frågeegenskapen kan användas för att filtrera rader.
mysql

Definition av en Azure SQL-datakälla vars autentiseringsuppgifter antingen kan vara en standard ADO.NET formaterad SQL-anslutningssträng eller ResourceId för SQL-resursen. Egenskapen container refererar till den tabell eller vy som ska indexeras. Frågeparametern stöds inte för den här datakällan.
adlsgen2

Definition av en Azure ADLS Gen 2-datakälla vars autentiseringsuppgifter antingen kan vara en lagringsanslutningssträng eller ResourceId för lagringskontot. Containeregenskapen refererar till blobcontainern som ska indexeras och den valfria frågeegenskapen refererar till en specifik undermapp i containern.
onelake

Definition av en Microsoft Fabric Onelake-datakälla vars autentiseringsuppgifter antingen kan vara GUID för infrastrukturarbetsytan eller ett FQDN för arbetsytan. Egenskapen container refererar till lakehouse GUID och den valfria frågeegenskapen refererar till mappar eller genvägar i lakehouse.

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.
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.