Sdílet prostřednictvím


Data Sources - Create

Vytvoří nový zdroj dat.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string

Adresa URL koncového bodu vyhledávací služby.

api-version
query True

string

Verze rozhraní API klienta.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-request-id

string (uuid)

ID sledování odeslané s požadavkem na pomoc s laděním.

Text požadavku

Name Vyžadováno Typ Description
container True

SearchIndexerDataContainer

Datový kontejner pro zdroj dat.

credentials True

DataSourceCredentials

Přihlašovací údaje pro zdroj dat.

name True

string

Název zdroje dat.

type True

SearchIndexerDataSourceType

Typ zdroje dat.

@odata.etag

string

ETag zdroje dat.

dataChangeDetectionPolicy DataChangeDetectionPolicy:

Zásady detekce změn dat pro zdroj dat.

dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

SoftDeleteColumnDeletionDetectionPolicy

Zásady detekce odstranění dat pro zdroj dat.

description

string

Popis zdroje dat.

encryptionKey

SearchResourceEncryptionKey

Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně šifrování neaktivních uložených dat pro definici zdroje dat, když chcete mít úplnou jistotu, že nikdo, ani Microsoft, nemůže dešifrovat definici vašeho zdroje dat. Jakmile definici zdroje dat zašifrujete, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby změnit, pokud chcete šifrovací klíč otočit; Definice vašeho zdroje dat nebude ovlivněna. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

Odpovědi

Name Typ Description
201 Created

SearchIndexerDataSource

Other Status Codes

ErrorResponse

Chybová odpověď.

Příklady

SearchServiceCreateDataSource

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
AzureActiveDirectoryApplicationCredentials

Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, která se používá pro ověřený přístup k šifrovacím klíčům uloženým v Azure Key Vault.

DataSourceCredentials

Představuje přihlašovací údaje, které lze použít pro připojení ke zdroji dat.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Chybová odpověď

HighWaterMarkChangeDetectionPolicy

Definuje zásadu detekce změn dat, která zachycuje změny na základě hodnoty sloupce s horní vodorovnou značkou.

SearchIndexerDataContainer

Představuje informace o entitě (například tabulce Azure SQL nebo kolekci CosmosDB), která bude indexována.

SearchIndexerDataSource

Představuje definici zdroje dat, kterou lze použít ke konfiguraci indexeru.

SearchIndexerDataSourceType

Definuje typ datového zdroje.

SearchResourceEncryptionKey

Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

SoftDeleteColumnDeletionDetectionPolicy

Definuje zásadu detekce odstranění dat, která implementuje strategii obnovitelného odstranění. Určuje, zda má být položka odstraněna na základě hodnoty určeného sloupce "obnovitelné odstranění".

SqlIntegratedChangeTrackingPolicy

Definuje zásadu detekce změn dat, která zachycuje změny pomocí funkce Integrované sledování změn služby Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, která se používá pro ověřený přístup k šifrovacím klíčům uloženým v Azure Key Vault.

Name Typ Description
applicationId

string

ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění k Azure Key Vault, které se má použít při šifrování neaktivních uložených dat. ID aplikace by nemělo být zaměňováno s ID objektu pro vaši aplikaci AAD.

applicationSecret

string

Ověřovací klíč zadané aplikace AAD.

DataSourceCredentials

Představuje přihlašovací údaje, které lze použít pro připojení ke zdroji dat.

Name Typ Description
connectionString

string

Připojovací řetězec pro zdroj dat. Pro Azure SQL, Azure Blob, ADLS Gen 2 a Azure Table by to byl připojovací řetězec nebo ID prostředku, pokud používáte spravovanou identitu. V případě CosmosDB by se jednalo o formátovaný připojovací řetězec určující ApiKind nebo ID prostředku pro spravovanou identitu. U souborů Onelake by připojovacím řetězcem byl buď identifikátor GUID pracovního prostoru, nebo plně kvalifikovaný název domény pracovního prostoru. Onelake podporuje pouze připojení spravovaných identit. Nastavte na <unchanged> (se závorkami), pokud nechcete, aby se připojovací řetězec aktualizoval. Nastavte na <redacted> , pokud chcete odebrat hodnotu připojovacího řetězce ze zdroje dat.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby.

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva.

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

HighWaterMarkChangeDetectionPolicy

Definuje zásadu detekce změn dat, která zachycuje změny na základě hodnoty sloupce s horní vodorovnou značkou.

Name Typ Description
@odata.type string:

#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy

Fragment identifikátoru URI určující typ zásady detekce změn dat.

highWaterMarkColumnName

string

Název sloupce s nejvyšší hladinou.

SearchIndexerDataContainer

Představuje informace o entitě (například tabulce Azure SQL nebo kolekci CosmosDB), která bude indexována.

Name Typ Description
name

string

Název tabulky nebo zobrazení (pro zdroj dat Azure SQL), kolekce (pro zdroj dat CosmosDB), kontejneru (pro zdroje dat Azure Blob a ADLS Gen 2), tabulky Azure (pro zdroj dat Azure Table) nebo lakehouse (pro zdroj dat Onelake), které se budou indexovat.

query

string

Dotaz, který je použit na tento datový kontejner. U zdroje dat CosmosDB může dotaz sloučit a filtrovat data. V případě Azure Blob a ADLS Gen 2 můžete dotaz filtrovat podle složek. V případě Azure Table můžete dotaz filtrovat podle dat řádků. U Onelake lze dotaz filtrovat podle složky nebo zástupce. Není podporováno zdroji dat Azure SQL.

SearchIndexerDataSource

Představuje definici zdroje dat, kterou lze použít ke konfiguraci indexeru.

Name Typ Description
@odata.etag

string

ETag zdroje dat.

container

SearchIndexerDataContainer

Datový kontejner pro zdroj dat.

credentials

DataSourceCredentials

Přihlašovací údaje pro zdroj dat.

dataChangeDetectionPolicy DataChangeDetectionPolicy:

Zásady detekce změn dat pro zdroj dat.

dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

SoftDeleteColumnDeletionDetectionPolicy

Zásady detekce odstranění dat pro zdroj dat.

description

string

Popis zdroje dat.

encryptionKey

SearchResourceEncryptionKey

Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně šifrování neaktivních uložených dat pro definici zdroje dat, když chcete mít úplnou jistotu, že nikdo, ani Microsoft, nemůže dešifrovat definici vašeho zdroje dat. Jakmile definici zdroje dat zašifrujete, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby změnit, pokud chcete šifrovací klíč otočit; Definice vašeho zdroje dat nebude ovlivněna. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

name

string

Název zdroje dat.

type

SearchIndexerDataSourceType

Typ zdroje dat.

SearchIndexerDataSourceType

Definuje typ datového zdroje.

Hodnota Description
azuresql

Definice zdroje dat Azure SQL, jehož přihlašovacími údaji může být buď standardní připojovací řetězec SQL, nebo ResourceId prostředku SQL. Vlastnost kontejner odkazuje na tabulku nebo zobrazení, které má být indexováno. Parametr dotazu není pro tento zdroj dat podporován.

cosmosdb

Definice datového zdroje CosmosDB, jehož přihlašovacími údaji může být buď formátovaný připojovací řetězec obsahující podrobnosti pro AccountEndpoint, AccountKey a Database pro připojení založené na klíči, nebo podrobnosti pro ResourceID a ApiKind pro bezklíčové připojení. Vlastnost container odkazuje na kolekci cosmosdb, která se má indexovat, a volitelná vlastnost query odkazuje na dotaz SQL v kolekci.

azureblob

Definice zdroje dat Azure Blob, jehož přihlašovacími údaji může být připojovací řetězec úložiště nebo ResourceId účtu úložiště. Vlastnost container odkazuje na kontejner objektů blob, který se má indexovat, a volitelná vlastnost query odkazuje na konkrétní podsložku v kontejneru.

azuretable

Definice zdroje dat Azure Table, jehož přihlašovacími údaji může být připojovací řetězec tabulky nebo ResourceId účtu úložiště. Vlastnost container odkazuje na kontejner objektů blob, který se má indexovat, a volitelnou vlastnost query lze použít k filtrování řádků.

mysql

Definice zdroje dat Azure SQL, jehož přihlašovacími údaji může být buď standardní ADO.NET formátovaný připojovací řetězec SQL, nebo ResourceId prostředku SQL. Vlastnost kontejner odkazuje na tabulku nebo zobrazení, které má být indexováno. Parametr dotazu není pro tento zdroj dat podporován.

adlsgen2

Definice zdroje dat Azure ADLS Gen 2, jehož přihlašovacími údaji může být buď připojovací řetězec úložiště, nebo ResourceId účtu úložiště. Vlastnost container odkazuje na kontejner objektů blob, který se má indexovat, a volitelná vlastnost query odkazuje na konkrétní podsložku v kontejneru.

onelake

Definice zdroje dat Microsoft Fabric Onelake, jehož přihlašovacími údaji může být buď identifikátor GUID pracovního prostoru Fabric, nebo plně kvalifikovaný název domény pracovního prostoru. Vlastnost kontejner odkazuje na identifikátor GUID lakehouse a volitelná vlastnost query odkazuje na složky nebo zástupce v lakehouse.

SearchResourceEncryptionKey

Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Name Typ Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Azure Key Vault. Není vyžadováno, pokud místo toho používáte spravovanou identitu.

keyVaultKeyName

string

Název vašeho klíče Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.

keyVaultKeyVersion

string

Verze klíče Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.

keyVaultUri

string

Identifikátor URI vašeho Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být https://my-keyvault-name.vault.azure.net.

SoftDeleteColumnDeletionDetectionPolicy

Definuje zásadu detekce odstranění dat, která implementuje strategii obnovitelného odstranění. Určuje, zda má být položka odstraněna na základě hodnoty určeného sloupce "obnovitelné odstranění".

Name Typ Description
@odata.type string:

#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy

Fragment identifikátoru URI určující typ zásad detekce odstranění dat.

softDeleteColumnName

string

Název sloupce, který se má použít pro detekci obnovitelného odstranění.

softDeleteMarkerValue

string

Hodnota značky, která identifikuje položku jako odstraněnou.

SqlIntegratedChangeTrackingPolicy

Definuje zásadu detekce změn dat, která zachycuje změny pomocí funkce Integrované sledování změn služby Azure SQL Database.

Name Typ Description
@odata.type string:

#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy

Fragment identifikátoru URI určující typ zásady detekce změn dat.