Data Sources - Create Or Update

Služba:: Search Service

Verze rozhraní API:: 2025-08-01-preview

Vytvoří nový zdroj dat nebo aktualizuje zdroj dat, pokud již existuje.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dataSourceName	path	True	string	Název zdroje dat, který chcete vytvořit nebo aktualizovat.
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string	Verze rozhraní API klienta.
ignoreResetRequirements	query		boolean	Ignoruje požadavky na obnovení mezipaměti.

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.
If-Match		string	Definuje podmínku If-Match. Operace bude provedena pouze v případě, že značka ETag na serveru odpovídá této hodnotě.
If-None-Match		string	Definuje podmínku If-None-Match. Operace bude provedena pouze v případě, že značka ETag na serveru neodpovídá této hodnotě.
Prefer	True	string	U požadavků HTTP PUT dává pokyn službě, aby v případě úspěchu vrátila vytvořený/aktualizovaný prostředek.

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	Značka ETag zdroje dat.
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Zásady detekce změn dat pro zdroj dat.
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy NativeBlobSoftDeleteDeletionDetectionPolicy	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.
identity		SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento zdroj dat. Pokud není zadán a připojovací řetězec je spravovaná identita, použije se spravovaná identita přiřazená systémem. Pokud není zadána, hodnota zůstane nezměněna. Pokud je zadáno "none", hodnota této vlastnosti je vymazána.
indexerPermissionOptions		IndexerPermissionOption[]	Možnosti příjmu dat s různými typy dat oprávnění.

Odpovědi

Name	Typ	Description
200 OK	SearchIndexerDataSource
201 Created	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Chybová odpověď.

Příklady

SearchServiceCreateOrUpdateDataSource

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 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"
  }
}

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.
IndexerPermissionOption	Možnosti s různými typy dat oprávnění k indexování.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definuje zásadu detekce odstranění dat s využitím nativní funkce obnovitelného odstranění služby Azure Blob Storage pro detekci odstranění.
SearchIndexerDataContainer	Představuje informace o entitě (například tabulce Azure SQL nebo kolekci CosmosDB), která bude indexována.
SearchIndexerDataNoneIdentity	Vymaže vlastnost identity zdroje dat.
SearchIndexerDataSource	Představuje definici zdroje dat, kterou lze použít ke konfiguraci indexeru.
SearchIndexerDataSourceType	Definuje typ datového zdroje.
SearchIndexerDataUserAssignedIdentity	Určuje identitu zdroje dat, který se má použít.
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

Objekt

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

Objekt

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

Objekt

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

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

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

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HighWaterMarkChangeDetectionPolicy

Objekt

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.

IndexerPermissionOption

Výčet

Možnosti s různými typy dat oprávnění k indexování.

Hodnota	Description
userIds	Indexer pro ingestování ID uživatelů seznamu ACL ze zdroje dat do indexu.
groupIds	Indexer pro ingestování identifikátorů skupin ACL ze zdroje dat do indexu.
rbacScope	Indexer pro ingestování oboru Azure RBAC ze zdroje dat do indexu.

NativeBlobSoftDeleteDeletionDetectionPolicy

Objekt

Definuje zásadu detekce odstranění dat s využitím nativní funkce obnovitelného odstranění služby Azure Blob Storage pro detekci odstranění.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Fragment identifikátoru URI určující typ zásad detekce odstranění dat.

SearchIndexerDataContainer

Objekt

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) nebo kolekce (pro zdroj dat CosmosDB), které budou indexovány.
query	string	Dotaz, který je použit na tento datový kontejner. Syntaxe a význam tohoto parametru je specifický pro zdroj dat. Není podporováno zdroji dat Azure SQL.

SearchIndexerDataNoneIdentity

Objekt

Vymaže vlastnost identity zdroje dat.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identifikátoru URI určující typ identity.

SearchIndexerDataSource

Objekt

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

Name	Typ	Description
@odata.etag	string	Značka ETag zdroje dat.
container	SearchIndexerDataContainer	Datový kontejner pro zdroj dat.
credentials	DataSourceCredentials	Přihlašovací údaje pro zdroj dat.
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	Zásady detekce změn dat pro zdroj dat.
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy 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.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento zdroj dat. Pokud není zadán a připojovací řetězec je spravovaná identita, použije se spravovaná identita přiřazená systémem. Pokud není zadána, hodnota zůstane nezměněna. Pokud je zadáno "none", hodnota této vlastnosti je vymazána.
indexerPermissionOptions	IndexerPermissionOption[]	Možnosti příjmu dat s různými typy dat oprávnění.
name	string	Název zdroje dat.
subType	string	Specifický typ datového zdroje, pokud je zdroj schopen různých modalit. Například 'MongoDb' pro určité účty 'cosmosDb'.
type	SearchIndexerDataSourceType	Typ zdroje dat.

SearchIndexerDataSourceType

Výčet

Definuje typ datového zdroje.

Hodnota	Description
azuresql	Označuje zdroj dat Azure SQL.
cosmosdb	Označuje zdroj dat CosmosDB.
azureblob	Označuje zdroj dat Azure Blob.
azuretable	Označuje zdroj dat Azure Table.
mysql	Označuje zdroj dat MySql.
adlsgen2	Označuje zdroj dat ADLS Gen2.
onelake	Označuje zdroj dat Microsoft Fabric OneLake.

SearchIndexerDataUserAssignedIdentity

Objekt

Určuje identitu zdroje dat, který se má použít.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identifikátoru URI určující typ identity.
userAssignedIdentity	string	Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", které by mělo být přiřazeno vyhledávací službě.

SearchResourceEncryptionKey

Objekt

Š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.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadán a vlastnost přístupových přihlašovacích údajů má hodnotu null, použije se spravovaná identita přiřazená systémem. Pokud při aktualizaci prostředku není explicitní identita určena, zůstane nezměněna. Pokud je zadáno "none", hodnota této vlastnosti je vymazána.
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

Objekt

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

Objekt

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.