Data Sources - Create Or Update

Služba:: Search Service

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

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

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dataSourceName	path	True	string	Název zdroje dat.
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
ignoreResetRequirements	query		boolean	Ignoruje požadavky na obnovení mezipaměti.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Accept		Accept	Hlavička Accept.
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	Prefer	U požadavků HTTP PUT dává pokyn službě, aby v případě úspěchu vrátila vytvořený/aktualizovaný prostředek.
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
container	True	SearchIndexerDataContainer	Kontejner dat pro zdroj dat.
name	True	string	Název zdroje dat.
type	True	SearchIndexerDataSourceType	Typ zdroje dat.
@odata.etag		string	ETag zdroje dat.
credentials.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.
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 zdroje dat nebude mít vliv. Š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í zadaný 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 beze změny. Pokud je zadána hodnota "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	Požadavek byl úspěšný.
201 Created	SearchIndexerDataSource	Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

SearchServiceCreateOrUpdateDataSource

Ukázkový požadavek

HTTP

PUT https://previewexampleservice.search.windows.net/datasources('tempdatasource')?api-version=2025-11-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
Accept	Hlavička Accept.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
HighWaterMarkChangeDetectionPolicy	Definuje zásadu detekce změn dat, která zachycuje změny na základě hodnoty sloupce horní značky.
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í ve službě Azure Blob Storage pro detekci odstranění.
Prefer	U požadavků HTTP PUT dává pokyn službě, aby v případě úspěchu vrátila vytvořený/aktualizovaný prostředek.
SearchIndexerDataContainer	Představuje informace o entitě (například tabulce Azure SQL nebo kolekci CosmosDB), která se bude indexovat.
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ého odstranění.
SqlIntegratedChangeTrackingPolicy	Definuje zásadu detekce změn dat, která zachycuje změny pomocí integrované funkce Change Tracking ve službě Azure SQL Database.

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

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

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

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

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 horní značky.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Nediskriminační pro odvozené typy.
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í ve službě Azure Blob Storage pro detekci odstranění.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	Nediskriminační pro odvozené typy.

Prefer

Výčet

U požadavků HTTP PUT dává pokyn službě, aby v případě úspěchu vrátila vytvořený/aktualizovaný prostředek.

Hodnota	Description
return=representation

SearchIndexerDataContainer

Objekt

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

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ý se použije pro tento kontejner dat. Syntaxe a význam tohoto parametru je specifický pro zdroj dat. Zdroje dat Azure SQL nepodporují.

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	ETag zdroje dat.
container	SearchIndexerDataContainer	Kontejner dat pro zdroj dat.
credentials.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.
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 zdroje dat nebude mít vliv. Š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í zadaný 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 beze změny. Pokud je zadána hodnota "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.
sharepoint	Označuje zdroj dat služby SharePoint.

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.applicationId	string	ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění ke službě 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.
accessCredentials.applicationSecret	string	Ověřovací klíč zadané aplikace AAD.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána.
keyVaultKeyName	string	Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI služby 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ého odstranění.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	Nediskriminační pro odvozené typy.
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í integrované funkce Change Tracking ve službě Azure SQL Database.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	Nediskriminační pro odvozené typy.