Data Sources - Get

Reference

Služba:: Search Service

Verze rozhraní API:: 2024-05-01-preview

Načte definici zdroje dat.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dataSourceName	path	True	string	Název zdroje dat, který se má načíst.
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é spolu s požadavkem na pomoc s laděním.

Odpovědi

Name	Typ	Description
200 OK	SearchIndexerDataSource
Other Status Codes	ErrorResponse	Odpověď na chybu.

Příklady

SearchServiceGetDataSource

Ukázkový požadavek

HTTP

GET https://myservice.search.windows.net/datasources('mydatasource')?api-version=2024-05-01-preview

Ukázková odpověď

Stavový kód:: 200

{
  "name": "mydocdbdatasource",
  "description": "My Cosmos DB data source.",
  "type": "cosmosdb",
  "credentials": {
    "connectionString": null
  },
  "container": {
    "name": "myDocDbCollectionId",
    "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts"
  },
  "dataChangeDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
    "highWaterMarkColumnName": "_ts"
  },
  "dataDeletionDetectionPolicy": {
    "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
    "softDeleteColumnName": "isDeleted",
    "softDeleteMarkerValue": "true"
  },
  "encryptionKey": {
    "keyVaultKeyName": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

Definice

Name	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje zaregistrované aplikace vytvořené pro vyhledávací službu, které slouží k ověřenému přístupu 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	Odpověď na chybu
HighWaterMarkChangeDetectionPolicy	Definuje zásadu detekce změn dat, která zaznamenává změny na základě hodnoty sloupce s vysokou hladinou.
NativeBlobSoftDeleteDeletionDetectionPolicy	Definuje zásadu detekce odstranění dat využívající nativní funkci obnovitelného odstranění Azure Blob Storage pro detekci odstranění.
SearchIndexerDataContainer	Představuje informace o entitě (například Azure SQL tabulce 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 zdroje dat.
SearchIndexerDataUserAssignedIdentity	Určuje identitu pro zdroj dat, který se má použít.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, můžete 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á zaznamenává změny pomocí integrované funkce Change Tracking služby Azure SQL Database.

AzureActiveDirectoryApplicationCredentials

Přihlašovací údaje zaregistrované aplikace vytvořené pro vyhledávací službu, které slouží k ověřenému přístupu 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 mají použít při šifrování neaktivních uložených dat. ID aplikace by se nemělo zaměňovat s ID objektu vaší aplikace 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. Pokud nechcete, aby se připojovací řetězec aktualizoval, nastavte na `<unchanged>` (se závorkami). Pokud chcete odebrat hodnotu připojovací řetězec ze zdroje dat, nastavte na `<redacted>` hodnotu .

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

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HighWaterMarkChangeDetectionPolicy

Definuje zásadu detekce změn dat, která zaznamenává změny na základě hodnoty sloupce s vysokou hladinou.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	Fragment identifikátoru URI určující typ zásad detekce změn dat.
highWaterMarkColumnName	string	Název sloupce s vysokou značkou vody.

NativeBlobSoftDeleteDeletionDetectionPolicy

Definuje zásadu detekce odstranění dat využívající nativní funkci obnovitelného odstranění 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

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

Name	Typ	Description
name	string	Název tabulky nebo zobrazení (pro Azure SQL zdroj dat) nebo kolekce (pro zdroj dat CosmosDB), která se bude indexovat.
query	string	Dotaz, který se použije na tento kontejner dat. Syntaxe a význam tohoto parametru jsou specifické pro zdroj dat. Nepodporuje Azure SQL zdroje dat.

SearchIndexerDataNoneIdentity

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

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	Kontejner dat pro zdroj dat.
credentials	DataSourceCredentials	Přihlašovací údaje ke zdroji 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 uložených dat pro definici zdroje dat, pokud chcete mít plnou jistotu, že nikdo, dokonce ani Microsoft, nemůže dešifrovat definici 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. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Na definici zdroje dat to 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í zadána a připojovací řetězec je spravovaná identita, použije se spravovaná identita přiřazená systémem. Pokud není zadán, zůstane hodnota beze změny. Pokud je zadána hodnota none, hodnota této vlastnosti se vymaže.
name	string	Název zdroje dat.
type	SearchIndexerDataSourceType	Typ zdroje dat.

SearchIndexerDataSourceType

Definuje typ zdroje dat.

Name	Typ	Description
adlsgen2	string	Označuje zdroj dat ADLS Gen2.
azureblob	string	Označuje zdroj dat objektu blob Azure.
azuresql	string	Označuje Azure SQL zdroj dat.
azuretable	string	Označuje zdroj dat tabulky Azure.
cosmosdb	string	Označuje zdroj dat CosmosDB.
mysql	string	Označuje zdroj dat MySql.
onelake	string	Označuje zdroj dat Microsoft Fabric OneLake.

SearchIndexerDataUserAssignedIdentity

Určuje identitu pro zdroj 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 tvaru /subscriptions/12345678-1234-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

Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, můžete 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 Key Vault Azure. Nevyžaduje se, pokud místo toho použijete spravovanou identitu.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána a vlastnost přihlašovacích údajů přístupu je null, použije se spravovaná identita přiřazená systémem. Pokud při aktualizaci prostředku není explicitní identita určená, zůstane beze změny. Pokud je zadána hodnota none, hodnota této vlastnosti se vymaže.
keyVaultKeyName	string	Název 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 Key Vault Azure, 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ého 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á zaznamenává změny pomocí integrované funkce Change Tracking služby Azure SQL Database.

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

Sdílet prostřednictvím