列出 Azure AI 搜尋服務 REST API (資料來源)

  • 發行項

列出資料來源作業會傳回 Azure AI 搜尋服務中的資料來源清單。

GET https://[service name].search.windows.net/datasources?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

URI 參數

參數 Description
服務名稱 必要。 將此設定為搜尋服務的唯一使用者定義名稱。
api-version 必要。 目前的穩定版本是 api-version=2020-06-30 。 如需更多版本，請參閱 API 版本 。

要求標頭

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

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

要求本文

無。

回應

要求成功：「200 確定」。 下列為回應本文的範例：

    {  
      "value" : [  
        {  
          "name": "datasource1",  
          "type": "azuresql",  
          ... other data source properties  
        }]  
    }

您可以將回應篩選為只篩選您感興趣的屬性。 例如，如果您只想要資料來源名稱的清單，請使用 OData 選取 查詢選項：

GET /datasources?api-version=2020-06-30&$select=name

在這種情況下，上述範例的回應就會顯示為：

    {  
      "value" : [ { "name": "datasource1" }, ... ]  
    }

注意

如果資料來源具有 加密金鑰，搜尋服務必須具有加密金鑰的存取權，才能在該資料來源的定義中擷取加密的屬性。 若沒有加密金鑰的存取權， "<encrypted>" 則會傳回預留位置來取代加密的屬性。 還原金鑰的存取權可讓搜尋服務再次擷取完整的資料來源定義。

另請參閱