Menyambungkan ke Azure AI Search menggunakan peran

1. Masuk ke portal Azure.

2. Tetapkan peran ini:

   • Pemilik (akses penuh ke semua bidang data dan operasi sarana kontrol, kecuali untuk izin kueri)
   • Kontributor (sama seperti Pemilik, kecuali izin untuk menetapkan peran)
   • Pembaca (dapat diterima untuk memantau dan melihat metrik)

Saat Anda menggunakan PowerShell untuk menetapkan peran, panggil New-AzRoleAssignment, menyediakan nama pengguna atau grup Azure, dan cakupan penugasan.

Contoh ini membuat penetapan peran yang dilingkup ke layanan pencarian:

New-AzRoleAssignment -SignInName <email> `
    -RoleDefinitionName "Reader" `
    -Scope  "/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Search/searchServices/<search-service>"

1. Masuk ke portal Azure.

2. Tetapkan peran ini:

   • Kontributor Layanan Pencarian (operasi create-read-update-delete pada indeks, pengindeks, set keterampilan, dan objek tingkat atas lainnya)
   • Kontributor Data Indeks Pencarian (memuat dokumen dan menjalankan pekerjaan pengindeksan)
   • Pembaca Data Indeks Pencarian (mengkueri indeks)

Saat Anda menggunakan PowerShell untuk menetapkan peran, panggil New-AzRoleAssignment, menyediakan nama pengguna atau grup Azure, dan cakupan penugasan.

Contoh ini membuat penetapan peran yang dilingkup ke layanan pencarian:

New-AzRoleAssignment -SignInName <email> `
    -RoleDefinitionName "Search Index Data Contributor" `
    -Scope  "/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Search/searchServices/<search-service>"

Contoh ini membuat penetapan peran yang dilingkup ke indeks tertentu:

New-AzRoleAssignment -SignInName <email> `
    -RoleDefinitionName "Search Index Data Contributor" `
    -Scope  "/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Search/searchServices/<search-service>/indexes/<index-name>"

1. Masuk ke portal Azure.

2. Tetapkan peran Pembaca Data Indeks Pencarian.

Saat menggunakan PowerShell untuk menetapkan peran, panggil New-AzRoleAssignment, yang menyediakan nama pengguna atau grup Azure dan cakupan penetapan.

1. Dapatkan ID langganan Anda, grup sumber daya layanan pencarian, dan nama layanan pencarian.

2. Dapatkan pengidentifikasi objek layanan Azure Anda, seperti Azure OpenAI.

    Get-AzADServicePrincipal -SearchString <YOUR AZURE OPENAI RESOURCE NAME>
   

3. Dapatkan definisi peran dan tinjau izin untuk memastikan ini adalah peran yang Anda inginkan.

   Get-AzRoleDefinition -Name "Search Index Data Reader"
   

4. Buat penetapan peran, ganti nilai yang valid untuk tempat penampung.

   New-AzRoleAssignment -ObjectId YOUR-AZURE-OPENAI-OBJECT-ID -RoleDefinitionName "Search Index Data Reader" -Scope /subscriptions/YOUR-SUBSCRIPTION-ID/resourcegroups/YOUR-RESOURCE-GROUP/providers/Microsoft.Search/searchServices/YOUR-SEARCH-SERVICE-NAME
   

5. Berikut adalah contoh penetapan peran yang dilingkup ke indeks tertentu:

   New-AzRoleAssignment -ObjectId YOUR-AZURE-OPENAI-OBJECT-ID `
       -RoleDefinitionName "Search Index Data Reader" `
       -Scope /subscriptions/YOUR-SUBSCRIPTION-ID/resourcegroups/YOUR-RESOURCE-GROUP/providers/Microsoft.Search/searchServices/YOUR-SEARCH-SERVICE-NAME/indexes/YOUR-INDEX-NAME
   

1. Masuk ke portal Azure.

2. Buka layanan pencarian Anda.

3. Di halaman Ringkasan, pilih Indeks:

   • Kontributor Layanan Pencarian dapat menampilkan dan membuat objek apa pun, tetapi tidak dapat memuat dokumen atau mengkueri indeks. Untuk memverifikasi izin, buat indeks pencarian.

   • Kontributor Data Indeks Pencarian dapat memuat dokumen. Tidak ada opsi muat dokumen di portal Azure di luar wizard Impor data, tetapi Anda dapat mengatur ulang dan menjalankan pengindeks untuk mengonfirmasi izin pemuatan dokumen.

   • Pembaca Data Indeks Pencarian dapat mengkueri indeks. Untuk memverifikasi izin, gunakan Penjelajah pencarian. Anda seharusnya dapat mengirim kueri dan melihat hasil, tetapi Anda seharusnya tidak dapat melihat definisi indeks atau membuatnya.

Pendekatan ini mengasumsikan Visual Studio Code dengan ekstensi klien REST.

1. Buka shell perintah untuk Azure CLI dan masuk ke langganan Azure Anda.

   az login
   

2. Dapatkan ID penyewa dan ID langganan Anda. ID digunakan sebagai variabel di langkah mendatang.

   az account show
   

3. Mendapatkan token akses.

   az account get-access-token --query accessToken --output tsv
   

4. Tempelkan variabel ini dalam file teks baru di Visual Studio Code.

   @baseUrl = PASTE-YOUR-SEARCH-SERVICE-URL-HERE
   @index-name = PASTE-YOUR-INDEX-NAME-HERE
   @token = PASTE-YOUR-TOKEN-HERE
   

5. Tempel lalu kirim permintaan yang menggunakan variabel yang telah Anda tentukan. Untuk peran "Pembaca Data Indeks Pencarian", Anda bisa mengirim kueri. Anda dapat menggunakan versi API yang didukung.

   POST https://{{baseUrl}}/indexes/{{index-name}}/docs/search?api-version=2024-07-01 HTTP/1.1
     Content-type: application/json
     Authorization: Bearer {{token}}
   
       {
            "queryType": "simple",
            "search": "motel",
            "filter": "",
            "select": "HotelName,Description,Category,Tags",
            "count": true
        }
   

Untuk informasi selengkapnya tentang cara memperoleh token untuk lingkungan tertentu, lihat Mengelola azure AI layanan Pencarian dengan REST API dan pustaka autentikasi platform identitas Microsoft.

1. Gunakan paket Azure.Search.Documents.

2. Gunakan Azure.Identity untuk .NET untuk autentikasi token. Microsoft merekomendasikan DefaultAzureCredential() untuk sebagian besar skenario.

3. Berikut adalah contoh koneksi klien menggunakan DefaultAzureCredential().

   // Create a SearchIndexClient to send create/delete index commands
   SearchIndexClient adminClient = new SearchIndexClient(serviceEndpoint, new DefaultAzureCredential());
   
   // Create a SearchClient to load and query documents
   SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, new DefaultAzureCredential());
   

4. Berikut adalah contoh lain menggunakan kredensial rahasia klien:

   var tokenCredential =  new ClientSecretCredential(aadTenantId, aadClientId, aadSecret);
   SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, tokenCredential);
   

1. Gunakan azure.search.documents (Azure SDK for Python).

2. Gunakan Azure.Identity untuk Python untuk autentikasi token.

3. Gunakan DefaultAzureCredential jika klien Python adalah aplikasi yang menjalankan sisi server. Aktifkan autentikasi interaktif jika aplikasi berjalan di browser.

4. Berikut contohnya:

   from azure.search.documents import SearchClient
   from azure.identity import DefaultAzureCredential
   
   credential = DefaultAzureCredential()
   endpoint = "https://<mysearch>.search.windows.net"
   index_name = "myindex"
   client = SearchClient(endpoint=endpoint, index_name=index_name, credential=credential)
   

1. Gunakan @azure/search-documents (Azure SDK untuk JavaScript), versi 11.3.

2. Gunakan Azure.Identity untuk JavaScript untuk autentikasi token.

3. Jika Anda menggunakan React, gunakan InteractiveBrowserCredential untuk autentikasi Microsoft Entra ke Pencarian. Lihat Kapan menggunakan @azure/identity untuk detailnya.

1. Gunakan azure-search-documents (Azure SDK for Java).

2. Gunakan Azure.Identity untuk Java untuk autentikasi token.

3. Microsoft merekomendasikan DefaultAzureCredential untuk aplikasi yang berjalan di Azure.

Langkah-langkah ini berasal dari Membuat atau memperbarui peran kustom Azure menggunakan portal Azure. Kloning dari peran yang ada didukung di halaman layanan pencarian.

Langkah-langkah ini membuat peran kustom yang menambah hak kueri pencarian untuk menyertakan daftar indeks menurut nama. Biasanya, mencantumkan indeks dianggap sebagai fungsi admin.

1. Di portal Azure, navigasikan ke layanan pencarian Anda.

2. Di panel navigasi kiri, pilih Kontrol Akses (IAM).

3. Di bilah tindakan, pilih Peran.

4. Klik kanan Pembaca Data Indeks Pencarian (atau peran lain) dan pilih Kloning untuk membuka wizard Buat peran kustom.

5. Pada tab Dasar, berikan nama untuk peran kustom, seperti "Search Index Data Explorer", lalu pilih Berikutnya.

6. Pada tab Izin, pilih Tambahkan izin.

7. Pada tab Tambahkan izin, cari lalu pilih petak peta Microsoft Search .

8. Atur izin untuk peran kustom Anda. Di bagian atas halaman, menggunakan pilihan Tindakan default:

   • Di bawah Microsoft.Search/operations, pilih Baca : Cantumkan semua operasi yang tersedia.
   • Di bawah Microsoft.Search/searchServices/indexes, pilih Baca : Baca Indeks.

9. Pada halaman yang sama, beralihlah ke Tindakan data dan di bawah Microsoft.Search/searchServices/indexes/documents, pilih Baca : Baca Dokumen.

   Definisi JSON terlihat seperti contoh berikut:

   {
    "properties": {
        "roleName": "search index data explorer",
        "description": "",
        "assignableScopes": [
            "/subscriptions/0000000000000000000000000000000/resourceGroups/free-search-svc/providers/Microsoft.Search/searchServices/demo-search-svc"
        ],
        "permissions": [
            {
                "actions": [
                    "Microsoft.Search/operations/read",
                    "Microsoft.Search/searchServices/indexes/read"
                ],
                "notActions": [],
                "dataActions": [
                    "Microsoft.Search/searchServices/indexes/documents/read"
                ],
                "notDataActions": []
            }
        ]
      }
    }
   

10. Pilih Tinjau + buat untuk membuat peran. Sekarang Anda dapat menetapkan pengguna dan grup ke peran tersebut.

Contoh PowerShell memperlihatkan sintaks JSON untuk membuat peran kustom yang merupakan kloning Pembaca Data Indeks Pencarian, tetapi dengan kemampuan untuk mencantumkan semua indeks berdasarkan nama.

1. Tinjau daftar izin atom untuk menentukan izin mana yang Anda butuhkan. Untuk contoh ini, Anda memerlukan hal berikut:

   "Microsoft.Search/operations/read",
   "Microsoft.Search/searchServices/read",
   "Microsoft.Search/searchServices/indexes/read"
   

2. Siapkan sesi PowerShell untuk membuat peran kustom. Untuk instruksi mendetail, lihat Azure PowerShell

3. Berikan definisi peran sebagai dokumen JSON. Contoh berikut menunjukkan sintaks untuk membuat peran kustom dengan PowerShell.

{
  "Name": "Search Index Data Explorer",
  "Id": "88888888-8888-8888-8888-888888888888",
  "IsCustom": true,
  "Description": "List all indexes on the service and query them.",
  "Actions": [
      "Microsoft.Search/operations/read",
      "Microsoft.Search/searchServices/read"
  ],
  "NotActions": [],
  "DataActions": [
      "Microsoft.Search/searchServices/indexes/read"
  ],
  "NotDataActions": [],
  "AssignableScopes": [
    "/subscriptions/{subscriptionId1}"
  ]
}

1. Tinjau daftar izin atom untuk menentukan izin mana yang Anda butuhkan.

2. Lihat Membuat atau memperbarui peran kustom Azure menggunakan REST API untuk langkah-langkahnya.

3. Salin atau buat peran, atau gunakan JSON untuk menentukan peran kustom (lihat tab PowerShell untuk sintaks JSON).

1. Tinjau daftar izin atom untuk menentukan izin mana yang Anda butuhkan.

2. Lihat Membuat atau memperbarui peran kustom Azure menggunakan Azure CLI untuk langkah-langkahnya.

3. Lihat tab PowerShell untuk sintaks JSON.