データ ソースの取得操作は、Azure AI Search からデータ ソース定義を取得します。
GET https://[service name].search.windows.net/datasources/[data source name]?api-version=[api-version]&includeConnectionString=[includeConnectionString]
Content-Type: application/json
api-key: [admin key]
URI パラメーター
| パラメーター | 説明 |
|---|---|
| サービス名 | 必須。 これを検索サービスの一意のユーザー定義名に設定します。 |
| データ ソース名 (data source name) | 必須。 要求 URI は、返すデータ ソースの名前を指定します。 |
| api-version | 必須。 現在の安定版は です api-version=2020-06-30。 その他 のバージョンについては、「API のバージョン 」を参照してください。 |
| includeConnectionString | 省略可能。 既定値は (false接続文字列応答から省略されます)。 にtrue設定すると、応答には、ユーザー名とパスワードを差し引いた接続文字列が含まれます (存在する場合)。 |
要求ヘッダー
次の表では、必須と省略可能の要求ヘッダーについて説明します。
| フィールド | 説明 |
|---|---|
| Content-Type | 必須。 これを application/json |
| api-key | Azure ロールを使用していて、要求にベアラー トークンが指定されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。 オブジェクト定義の要求を取得するには、(クエリ キーではなく) 管理キーに設定された api-key フィールドを含める必要があります。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。 |
要求本文
[なし] :
Response
状態コード: 応答の成功に対して「200 OK」が返されます。
応答本文は、 データ ソースの作成 (Azure AI Search REST API) の例に似ています。
注意
既定では、接続文字列は応答で返されません。 URI パラメーターincludeConnectionStringが にtrue設定されている場合、応答でユーザー名とパスワードのトリミングされた接続文字列が返されます。
{
"name" : "asqldatasource",
"description" : "a description",
"type" : "azuresql",
"credentials" : { "connectionString" : null },
"container" : { "name" : "sometable" },
"dataChangeDetectionPolicy" : {
"@odata.type" : "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy",
"highWaterMarkColumnName" : "RowVersion" },
"dataDeletionDetectionPolicy" : {
"@odata.type" : "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy",
"softDeleteColumnName" : "IsDeleted",
"softDeleteMarkerValue" : "true" },
"encryptionKey": null
}
注意
この API を呼び出すときは Accept 要求ヘッダーを application/json;odata.metadata=none に設定しないでください。設定すると、応答から @odata.type 属性が省略され、さまざまな種類のデータ変更/データ削除検出ポリシーを区別できなくなります。
注意
データ ソースに 暗号化キーがある場合、検索サービスはデータ ソース定義を取得するために暗号化キーにアクセスできる必要があります。 暗号化キーにアクセスしないと、400 Bad Request が返されます。 キーへのアクセスを復元すると、検索サービスはデータ ソース定義を再度取得できます。