取得 Azure AI 搜尋服務 REST API (資料來源)

  • 發行項

取得資料來源作業會從 Azure AI 搜尋服務取得資料來源定義。

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 參數

參數 Description
服務名稱 必要。 將此設定為搜尋服務的唯一使用者定義名稱。
資料來源名稱 (data source name) 必要。 要求 URI 指定要傳回的資料來源名稱。
api-version 必要。 目前的穩定版本是 api-version=2020-06-30 。 如需更多版本，請參閱 API 版本 。
includeConnectionString 選擇性。 預設為 false (連接字串 省略回應) 。 當設定為 true 時，如果回應存在，則回應會包含連接字串，並減去使用者名稱和密碼。

要求標頭

下表說明必要及選用的要求標頭。

欄位 Description
Content-Type 必要。 請設為 application/json
api-key 如果您使用 Azure 角色 ，並在要求上提供持有人權杖，則為選擇性，否則需要金鑰。 API 金鑰是唯一的系統產生字串，可驗證對搜尋服務的要求。 取得物件定義的要求必須包含設定為系統管理員金鑰的 api 金鑰欄位， (而不是查詢金鑰) 。 如需詳細資訊，請參閱 使用金鑰驗證連線到 Azure AI 搜尋 服務。

要求本文

無。

回應

回應成功時會傳回狀態碼：200 OK。

回應本文類似于 建立資料來源 (Azure AI 搜尋 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 不正確的要求。 還原金鑰的存取權可讓搜尋服務再次擷取資料來源定義。

另請參閱