Data Sources - Create

サービス:: Search Service

API バージョン:: 2025-09-01

新しいデータソースを作成します。

POST {endpoint}/datasources?api-version=2025-09-01

URI パラメーター

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

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	デバッグを支援するためにリクエストとともに送信されたトラッキング ID。

要求本文

名前	必須	型	説明
container	True	SearchIndexerDataContainer	データソースのデータコンテナ。
credentials	True	DataSourceCredentials	データソースの資格情報。
name	True	string	データソースの名前。
type	True	SearchIndexerDataSourceType	データソースのタイプ。
@odata.etag		string	データソースの ETag。
dataChangeDetectionPolicy		DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	データソースのデータ変更検出ポリシー。
dataDeletionDetectionPolicy		DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	データソースのデータ削除検出ポリシー。
description		string	データソースの説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。このキーは、Microsoft を含む誰もデータソース定義の暗号化を解除できないことを完全に保証する必要がある場合に、データソース定義に追加レベルの保存時の暗号化を提供するために使用されます。データソース定義を暗号化すると、常に暗号化されたままになります。検索サービスは、このプロパティを null に設定しようとすると無視されます。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データソース定義は影響を受けません。カスタマーマネージドキーによる暗号化は、無料の検索サービスでは使用できず、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

応答

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

例

SearchServiceCreateDataSource

要求のサンプル

HTTP

POST https://stableexampleservice.search.windows.net/datasources?api-version=2025-09-01


{
  "name": "tempdatasource",
  "description": "My Azure Blob data source.",
  "type": "azureblob",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "doc-extraction-skillset",
    "query": "E2E_Dsat"
  },
  "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"
}

応答のサンプル

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempdatasource",
  "description": "My Azure Blob data source.",
  "type": "azureblob",
  "credentials": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net "
  },
  "container": {
    "name": "doc-extraction-skillset",
    "query": "E2E_Dsat"
  },
  "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	高水準点列の値に基づいて変更をキャプチャするデータ変更検出ポリシーを定義します。
SearchIndexerDataContainer	インデックスが作成されるエンティティ (Azure SQL テーブルや CosmosDB コレクションなど) に関する情報を表します。
SearchIndexerDataSource	インデクサーの構成に使用できるデータソース定義を表します。
SearchIndexerDataSourceType	データソースのタイプを定義します。
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	データソースの接続文字列。 Azure SQL、Azure Blob、ADLS Gen 2、Azure Table の場合、マネージド ID を使用する場合は、接続文字列またはリソース ID になります。 CosmosDB の場合、これは、マネージド ID の ApiKind またはリソース ID を指定する書式設定された接続文字列になります。 Onelake ファイルの場合、接続文字列はワークスペース GUID またはワークスペース FQDN のいずれかになります。Onelake では、マネージド ID 接続のみがサポートされます。接続文字列を更新しない場合は、 `<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	最高水準点列の名前。

SearchIndexerDataContainer

Object

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

名前	型	説明
name	string	インデックスが作成されるテーブルまたはビュー (Azure SQL データソースの場合)、コレクション (CosmosDB データソースの場合)、コンテナー (Azure BLOB および ADLS Gen 2 データソースの場合)、Azure テーブル (Azure テーブルデータソースの場合)、またはレイクハウス (Onelake データソースの場合) の名前。
query	string	このデータコンテナに適用されるクエリ。 CosmosDB の場合、データソースクエリではデータをフラット化してフィルター処理できます。 Azure BLOB と ADLS Gen 2 の場合、クエリはフォルダーでフィルター処理できます。 Azure テーブルの場合、クエリは行データでフィルター処理できます。 Onelake の場合、クエリはフォルダーまたはショートカットでフィルター処理できます。 Azure SQL データソースではサポートされていません。

SearchIndexerDataSource

Object

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

名前	型	説明
@odata.etag	string	データソースの ETag。
container	SearchIndexerDataContainer	データソースのデータコンテナ。
credentials	DataSourceCredentials	データソースの資格情報。
dataChangeDetectionPolicy	DataChangeDetectionPolicy: HighWaterMarkChangeDetectionPolicy SqlIntegratedChangeTrackingPolicy	データソースのデータ変更検出ポリシー。
dataDeletionDetectionPolicy	DataDeletionDetectionPolicy: SoftDeleteColumnDeletionDetectionPolicy	データソースのデータ削除検出ポリシー。
description	string	データソースの説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。このキーは、Microsoft を含む誰もデータソース定義の暗号化を解除できないことを完全に保証する必要がある場合に、データソース定義に追加レベルの保存時の暗号化を提供するために使用されます。データソース定義を暗号化すると、常に暗号化されたままになります。検索サービスは、このプロパティを null に設定しようとすると無視されます。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データソース定義は影響を受けません。カスタマーマネージドキーによる暗号化は、無料の検索サービスでは使用できず、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
name	string	データソースの名前。
type	SearchIndexerDataSourceType	データソースのタイプ。

SearchIndexerDataSourceType

列挙

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

値	説明
azuresql	資格情報が標準の SQL 接続文字列または SQL リソースの ResourceId のいずれかである Azure SQL データソースの定義。コンテナープロパティは、インデックスを作成するテーブルまたはビューを参照します。クエリパラメーターは、このデータソースではサポートされていません。
cosmosdb	資格情報は、キーベースの接続の場合は AccountEndpoint、AccountKey、Database の詳細を含む書式設定された接続文字列、またはキーレス接続の場合は ResourceID と ApiKind の詳細を含む書式設定された接続文字列のいずれかである CosmosDB データソースの定義。 container プロパティはインデックスを作成する cosmosdb コレクションを参照し、省略可能な query プロパティはコレクションの SQL クエリを参照します。
azureblob	資格情報がストレージ接続文字列またはストレージアカウントの ResourceId のいずれかである Azure BLOB データソースの定義。コンテナープロパティはインデックスを作成する BLOB コンテナーを参照し、オプションのクエリプロパティはコンテナー内の特定のサブフォルダーを参照します。
azuretable	資格情報がテーブル接続文字列またはストレージアカウントの ResourceId のいずれかである Azure Table データソースの定義。 container プロパティは、インデックスを作成する BLOB コンテナーを参照し、オプションの query プロパティを使用して行をフィルター処理できます。
mysql	資格情報が標準 ADO.NET 書式設定された SQL 接続文字列または SQL リソースの ResourceId のいずれかである Azure SQL データソースの定義。コンテナープロパティは、インデックスを作成するテーブルまたはビューを参照します。クエリパラメーターは、このデータソースではサポートされていません。
adlsgen2	資格情報がストレージ接続文字列またはストレージアカウントの ResourceId のいずれかである Azure ADLS Gen 2 データソースの定義。コンテナープロパティはインデックスを作成する BLOB コンテナーを参照し、オプションのクエリプロパティはコンテナー内の特定のサブフォルダーを参照します。
onelake	資格情報が Fabric ワークスペース GUID またはワークスペース FQDN のいずれかである Microsoft Fabric Onelake データソースの定義。コンテナープロパティはレイクハウス GUID を参照し、オプションのクエリプロパティはレイクハウス内のフォルダーまたはショートカットを参照します。

SearchResourceEncryptionKey

Object

Azure Key Vault の顧客管理暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。

名前	型	説明
accessCredentials	AzureActiveDirectoryApplicationCredentials	Azure Key Vault へのアクセスに使用されるオプションの Azure Active Directory 資格情報。代わりにマネージド ID を使用する場合は必要ありません。
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 フラグメント。

次の方法で共有

Data Sources - Create

URI パラメーター

要求ヘッダー

要求本文

応答

例

SearchServiceCreateDataSource

要求のサンプル

応答のサンプル

定義

AzureActiveDirectoryApplicationCredentials

DataSourceCredentials

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HighWaterMarkChangeDetectionPolicy

SearchIndexerDataContainer

SearchIndexerDataSource

SearchIndexerDataSourceType

SearchResourceEncryptionKey

SoftDeleteColumnDeletionDetectionPolicy

SqlIntegratedChangeTrackingPolicy