Data Sources - Get

サービス:: Search Service

API バージョン:: 2024-03-01-Preview

データソース定義を取得します。

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

URI パラメーター

名前	/	必須	型	説明
dataSourceName	path	True	string	取得するデータソースの名前。
endpoint	path	True	string	検索サービスのエンドポイント URL。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	デバッグに役立つ要求と共に送信される追跡 ID。

応答

名前	型	説明
200 OK	SearchIndexerDataSource
Other Status Codes	ErrorResponse	エラー応答。

例

SearchServiceGetDataSource

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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
    }
  }
}

定義

名前	説明
AzureActiveDirectoryApplicationCredentials	Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用される、検索サービス用に作成された登録済みアプリケーションの資格情報。
DataSourceCredentials	データソースへの接続に使用できる資格情報を表します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
HighWaterMarkChangeDetectionPolicy	高基準列の値に基づいて変更をキャプチャするデータ変更検出ポリシーを定義します。
NativeBlobSoftDeleteDeletionDetectionPolicy	Azure Blob Storage のネイティブの論理的な削除機能を使用して削除検出を行うデータ削除検出ポリシーを定義します。
SearchIndexerDataContainer	インデックスが作成されるエンティティ (Azure SQL テーブルや CosmosDB コレクションなど) に関する情報を表します。
SearchIndexerDataNoneIdentity	データソースの ID プロパティをクリアします。
SearchIndexerDataSource	インデクサーの構成に使用できるデータソース定義を表します。
SearchIndexerDataSourceType	データソースの型を定義します。
SearchIndexerDataUserAssignedIdentity	使用するデータソースの ID を指定します。
SearchResourceEncryptionKey	Azure Key Vault のカスタマーマネージド暗号化キー。作成および管理するキーは、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除に使用できます。
SoftDeleteColumnDeletionDetectionPolicy	論理的な削除戦略を実装するデータ削除検出ポリシーを定義します。指定された "論理的な削除" 列の値に基づいて、アイテムを削除するかどうかを決定します。
SqlIntegratedChangeTrackingPolicy	Azure SQL Database の統合変更追跡機能を使用して変更をキャプチャするデータ変更検出ポリシーを定義します。

AzureActiveDirectoryApplicationCredentials

Object

Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用される、検索サービス用に作成された登録済みアプリケーションの資格情報。

名前	型	説明
applicationId	string	保存データの暗号化時に使用される Azure Key Vault に対する必要なアクセス許可が付与された AAD アプリケーション ID。アプリケーション ID は、AAD アプリケーションのオブジェクト ID と混同しないでください。
applicationSecret	string	指定した AAD アプリケーションの認証キー。

DataSourceCredentials

Object

データソースへの接続に使用できる資格情報を表します。

名前	型	説明
connectionString	string	データソースの接続文字列。接続文字列を更新しない場合は、`<unchanged>` (角かっこ付き) に設定します。データソースから接続文字列の値を削除する場合は、`<redacted>` に設定します。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

HighWaterMarkChangeDetectionPolicy

Object

高基準列の値に基づいて変更をキャプチャするデータ変更検出ポリシーを定義します。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy	データ変更検出ポリシーの種類を指定する URI フラグメント。
highWaterMarkColumnName	string	高い基準値の列の名前。

NativeBlobSoftDeleteDeletionDetectionPolicy

Object

Azure Blob Storage のネイティブの論理的な削除機能を使用して削除検出を行うデータ削除検出ポリシーを定義します。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy	データ削除検出ポリシーの種類を指定する URI フラグメント。

SearchIndexerDataContainer

Object

インデックスが作成されるエンティティ (Azure SQL テーブルや CosmosDB コレクションなど) に関する情報を表します。

名前	型	説明
name	string	インデックスが作成されるテーブルまたはビュー (Azure SQL データソースの場合) またはコレクション (CosmosDB データソースの場合) の名前。
query	string	このデータコンテナーに適用されるクエリ。このパラメーターの構文と意味はデータソース固有です。 Azure SQL データソースではサポートされていません。

SearchIndexerDataNoneIdentity

Object

データソースの ID プロパティをクリアします。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	ID の種類を指定する URI フラグメント。

SearchIndexerDataSource

Object

インデクサーの構成に使用できるデータソース定義を表します。

名前	型	説明
@odata.etag	string	データソースの ETag。
container	SearchIndexerDataContainer	データソースのデータコンテナー。
credentials	DataSourceCredentials	データソースの資格情報。
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	データソースのデータ変更検出ポリシー。
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: NativeBlobSoftDeleteDeletionDetectionPolicy SoftDeleteColumnDeletionDetectionPolicy	データソースのデータ削除検出ポリシー。
description	string	データソースの説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。このキーを使用して、データソース定義に保存時の暗号化レベルを追加します。これは、Microsoft 以外のユーザーがデータソース定義の暗号化を解除できないという完全な保証が必要な場合に使用されます。データソース定義を暗号化すると、常に暗号化されたままになります。検索サービスは、このプロパティを null に設定する試行を無視します。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データソース定義は影響を受けません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	このデータソースに使用する明示的なマネージド ID。指定されず、接続文字列がマネージド ID の場合は、システム割り当てマネージド ID が使用されます。指定しない場合、値は変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。
name	string	データソースの名前。
type	SearchIndexerDataSourceType	データソースの型。

SearchIndexerDataSourceType

列挙

データソースの型を定義します。

値	説明
azuresql	Azure SQL データソースを示します。
cosmosdb	CosmosDB データソースを示します。
azureblob	Azure BLOB データソースを示します。
azuretable	Azure Table データソースを示します。
mysql	MySql データソースを示します。
adlsgen2	ADLS Gen2 データソースを示します。

SearchIndexerDataUserAssignedIdentity

Object

使用するデータソースの ID を指定します。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	ID の種類を指定する URI フラグメント。
userAssignedIdentity	string	通常、ユーザー割り当てマネージド ID の完全修飾 Azure リソース ID は、検索サービスに割り当てられている必要がある "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" の形式です。

SearchResourceEncryptionKey

Object

Azure Key Vault のカスタマーマネージド暗号化キー。作成および管理するキーは、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除に使用できます。

名前	型	説明
accessCredentials	AzureActiveDirectoryApplicationCredentials	Azure Key Vault へのアクセスに使用されるオプションの Azure Active Directory 資格情報。代わりにマネージド ID を使用する場合は必要ありません。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	この暗号化キーに使用する明示的なマネージド ID。指定されず、アクセス資格情報プロパティが null の場合は、システム割り当てマネージド ID が使用されます。リソースの更新時に、明示的な ID が指定されていない場合、変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。
keyVaultKeyName	string	保存データの暗号化に使用する Azure Key Vault キーの名前。
keyVaultKeyVersion	string	保存データの暗号化に使用する Azure Key Vault キーのバージョン。
keyVaultUri	string	保存データの暗号化に使用するキーを含む Azure Key Vault の URI (DNS 名とも呼ばれます)。 URI の例は、`https://my-keyvault-name.vault.azure.net`可能性があります。

SoftDeleteColumnDeletionDetectionPolicy

Object

論理的な削除戦略を実装するデータ削除検出ポリシーを定義します。指定された "論理的な削除" 列の値に基づいて、アイテムを削除するかどうかを決定します。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy	データ削除検出ポリシーの種類を指定する URI フラグメント。
softDeleteColumnName	string	論理的な削除の検出に使用する列の名前。
softDeleteMarkerValue	string	アイテムを削除済みとして識別するマーカー値。

SqlIntegratedChangeTrackingPolicy

Object

Azure SQL Database の統合変更追跡機能を使用して変更をキャプチャするデータ変更検出ポリシーを定義します。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy	データ変更検出ポリシーの種類を指定する URI フラグメント。