Dapatkan Sumber Data (Azure AI Search REST API)

  • Artikel

Operasi Dapatkan Sumber Data mendapatkan definisi sumber data dari 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]

Parameter URI

Parameter Deskripsi
nama layanan Wajib diisi. Atur ini ke nama unik yang ditentukan pengguna dari layanan pencarian Anda.
nama sumber data Wajib diisi. URI permintaan menentukan nama sumber data yang akan dikembalikan.
versi-api Wajib diisi. Versi stabil saat ini adalah api-version=2020-06-30. Lihat versi API untuk versi lainnya.
includeConnectionString Opsional. Defaultnya adalah false (string koneksi dihilangkan dari respons). Saat diatur ke true, respons menyertakan string koneksi, dikurangi nama pengguna dan kata sandi, jika ada.

Judul Permintaan

Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.

Bidang Deskripsi
Jenis-Konten Wajib diisi. Atur titik akhir ini ke application/json
api-key Opsional jika Anda menggunakan peran Azure dan token pembawa disediakan berdasarkan permintaan, jika tidak, kunci diperlukan. Kunci api adalah string unik yang dihasilkan sistem yang mengautentikasi permintaan ke layanan pencarian Anda. Dapatkan permintaan untuk definisi objek harus menyertakan bidang kunci api yang diatur ke kunci admin Anda (dibandingkan dengan kunci kueri). Lihat Menyambungkan ke Pencarian Azure AI menggunakan autentikasi kunci untuk detailnya.

Isi Permintaan

Tidak ada.

Respons

Kode Status: 200 OK dikembalikan untuk respons yang berhasil.

Isi respons mirip dengan contoh di Buat Sumber Data (Azure AI Search REST API).

Catatan

Secara default, string koneksi tidak dikembalikan dalam respons. Jika parameter includeConnectionString URI diatur ke true, string koneksi dipangkas dari nama pengguna dan kata sandi dikembalikan dalam respons.

{
    "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
}

Catatan

Jangan atur Accept header permintaan ke application/json;odata.metadata=none saat memanggil API ini karena hal tersebut akan menyebabkan @odata.type atribut dihilangkan dari respons dan Anda tidak akan dapat membedakan antara perubahan data dan kebijakan deteksi penghapusan data dari berbagai jenis.

Catatan

Jika sumber data memiliki kunci enkripsi, layanan pencarian harus memiliki akses ke kunci enkripsi untuk mengambil definisi sumber data. Tanpa akses ke kunci enkripsi, 400 Permintaan Buruk dikembalikan. Memulihkan akses ke kunci memungkinkan layanan pencarian untuk mengambil definisi sumber data lagi.

Lihat juga