Data Sources - Get

サービス:: Search Service

API バージョン:: 2025-08-01-preview

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

GET {endpoint}/datasources('{dataSourceName}')?api-version=2025-08-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://previewexampleservice.search.windows.net/datasources('mydocdbdatasource')?api-version=2025-08-01-preview

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mydocdbdatasource",
  "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"
  }
}

定義

名前	説明
AzureActiveDirectoryApplicationCredentials	検索サービス用に作成された登録済みアプリケーションの資格情報で、Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用されます。
DataSourceCredentials	データソースへの接続に使用できる資格情報を表します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
HighWaterMarkChangeDetectionPolicy	高水準点列の値に基づいて変更をキャプチャするデータ変更検出ポリシーを定義します。
IndexerPermissionOption	インデックスを作成するさまざまなタイプのアクセス許可データを含むオプション。
NativeBlobSoftDeleteDeletionDetectionPolicy	削除検出に Azure Blob Storage のネイティブ論理削除機能を利用するデータ削除検出ポリシーを定義します。
SearchIndexerDataContainer	インデックスが作成されるエンティティ (Azure SQL テーブルや CosmosDB コレクションなど) に関する情報を表します。
SearchIndexerDataNoneIdentity	データソースの identity プロパティをクリアします。
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	最高水準点列の名前。

IndexerPermissionOption

列挙

インデックスを作成するさまざまなタイプのアクセス許可データを含むオプション。

値	説明
userIds	データソースからインデックスに ACL userId を取り込むインデクサー。
groupIds	データソースからインデックスに ACL groupId を取り込むインデクサー。
rbacScope	データソースからインデックスに Azure RBAC スコープを取り込むインデクサー。

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

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

名前	型	説明
@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" を指定すると、このプロパティの値はクリアされます。
indexerPermissionOptions	IndexerPermissionOption[]	さまざまな種類のアクセス許可データを含む取り込みオプション。
name	string	データソースの名前。
subType	string	リソースがさまざまなモダリティに対応している場合の特定のタイプのデータソース。たとえば、特定の 'cosmosDb' アカウントの場合は 'MongoDb' です。
type	SearchIndexerDataSourceType	データソースのタイプ。

SearchIndexerDataSourceType

列挙

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

値	説明
azuresql	Azure SQL データソースを示します。
cosmosdb	CosmosDB データソースを示します。
azureblob	Azure BLOB データソースを示します。
azuretable	Azure テーブルデータソースを示します。
mysql	MySqlデータソースを示します。
adlsgen2	ADLS Gen2 データソースを示します。
onelake	Microsoft Fabric OneLake データソースを示します。

SearchIndexerDataUserAssignedIdentity

Object

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

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	ID のタイプを指定する URI フラグメント。
userAssignedIdentity	string	ユーザーが割り当てたマネージド ID の完全修飾 Azure リソース ID は、通常、検索サービスに割り当てられている必要がある "/subscriptions/1234-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 フラグメント。