Data Sources - Create

サービス:
Search Service
API バージョン:
2026-04-01

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

POST {endpoint}/datasources?api-version=2026-04-01

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string (uri)

検索サービスのエンドポイント URL。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
Accept

Accept

Acceptヘッダーです。
x-ms-client-request-id

string (uuid)

要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前 必須 型 説明
container True

SearchIndexerDataContainer

データソースのデータ コンテナー。
name True

string

データソースの名前。
type True

SearchIndexerDataSourceType

データソースの型。
@odata.etag

string

データ ソースの ETag。
credentials.connectionString

string

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

データソースのデータ変更検出ポリシー。
dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

データソースのデータ削除検出ポリシー。
description

string

データソースの説明。
encryptionKey

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 このキーは、Microsoft を含む誰もデータ ソース定義の暗号化を解除できないことを完全に保証する必要がある場合に、データ ソース定義に追加レベルの保存時の暗号化を提供するために使用されます。 データ ソース定義を暗号化すると、常に暗号化されたままになります。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データソース定義は影響を受けません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
identity SearchIndexerDataIdentity:

このデータソースに使用する明示的なマネージド ID。 指定されず、接続文字列がマネージド ID の場合は、システム割り当てマネージド ID が使用されます。 指定しない場合、値は変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。

応答

名前 型 説明
201 Created

SearchIndexerDataSource

要求が成功し、結果として新しいリソースが作成されました。
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前 説明
https://search.azure.com/.default

例

SearchServiceCreateDataSource

要求のサンプル

POST https://exampleservice.search.windows.net/datasources?api-version=2026-04-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"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  },
  "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"
  },
  "identity": {
    "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
  }
}

定義

名前 説明
Accept

Acceptヘッダーです。
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
HighWaterMarkChangeDetectionPolicy

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

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

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

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

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

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

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

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

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

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

Accept

列挙

Acceptヘッダーです。

値 説明
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

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

名前 型 説明
info

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

HighWaterMarkChangeDetectionPolicy

Object

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

名前 型 説明
@odata.type string:

#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy

派生型の識別子。
highWaterMarkColumnName

string

高い基準値の列の名前。

NativeBlobSoftDeleteDeletionDetectionPolicy

Object

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

名前 型 説明
@odata.type string:

#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy

派生型の識別子。

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.connectionString

string

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

データソースのデータ変更検出ポリシー。
dataDeletionDetectionPolicy DataDeletionDetectionPolicy:

データソースのデータ削除検出ポリシー。
description

string

データソースの説明。
encryptionKey

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 このキーは、Microsoft を含む誰もデータ ソース定義の暗号化を解除できないことを完全に保証する必要がある場合に、データ ソース定義に追加レベルの保存時の暗号化を提供するために使用されます。 データ ソース定義を暗号化すると、常に暗号化されたままになります。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データソース定義は影響を受けません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
identity SearchIndexerDataIdentity:

このデータソースに使用する明示的なマネージド ID。 指定されず、接続文字列がマネージド ID の場合は、システム割り当てマネージド ID が使用されます。 指定しない場合、値は変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。
name

string

データソースの名前。
type

SearchIndexerDataSourceType

データソースの型。

SearchIndexerDataSourceType

列挙

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

値 説明
azuresql

Azure SQL データソースを示します。
cosmosdb

CosmosDB データ ソースを示します。
azureblob

Azure BLOB データソースを示します。
azuretable

Azure テーブル データ ソースを示します。
mysql

MySqlデータソースを示します。
adlsgen2

ADLS Gen2 データ ソースを示します。
onelake

Microsoft Fabric OneLake データ ソースを示します。
sharepoint

SharePointのデータソースを示しています。

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.applicationId

string

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

string

指定した AAD アプリケーションの認証キー。
identity SearchIndexerDataIdentity:

この暗号化キーに使用する明示的なマネージド 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

派生型の識別子。
softDeleteColumnName

string

論理的な削除の検出に使用する列の名前。
softDeleteMarkerValue

string

アイテムを削除済みとして識別するマーカー値。

SqlIntegratedChangeTrackingPolicy

Object

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

名前 型 説明
@odata.type string:

#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy

派生型の識別子。