Menggunakan Azure CLI untuk membuat atau memperbarui sumber daya Azure Bot
BERLAKU UNTUK: SDK v4
Artikel ini menjelaskan cara membuat atau memperbarui sumber daya Azure Bot dengan Azure CLI dan templat Azure Resource Manager (templat ARM).
Ini adalah bagian dari proses yang lebih besar untuk menyediakan dan menerbitkan bot.
- Untuk informasi tentang proses lengkap, lihat Memprovisikan dan menerbitkan bot.
- Untuk informasi tentang cara membuat sumber daya App Service, lihat Menggunakan Azure CLI untuk membuat sumber daya App Service.
- Untuk instruksi tentang cara menggunakan portal Azure, lihat mulai cepat Membuat sumber daya Azure Bot.
Catatan
Bot Framework JavaScript, C#, dan Python SDK akan terus didukung, namun, Java SDK dihentikan dengan dukungan jangka panjang akhir yang berakhir pada November 2023.
Bot yang ada yang dibangun dengan Java SDK akan terus berfungsi.
Untuk pembuatan bot baru, pertimbangkan untuk menggunakan Microsoft Copilot Studio dan baca tentang memilih solusi salinan yang tepat.
Untuk informasi selengkapnya, lihat Masa depan pembuatan bot.
Prasyarat
Untuk menggunakan Azure CLI untuk memprovisikan dan menerbitkan bot, Anda memerlukan:
Akun Azure yang memiliki langganan aktif. Buat akun gratis.
Penginstalan Azure CLI.
Untuk bahasa pemrograman Anda, gunakan versi Azure CLI berikut. Beberapa langkah tidak akan berfungsi dengan versi CLI yang lebih baru.
Bahasa Versi CLI C# dan JavaScript 2.39.0 atau yang lebih baru Python 2.55.0 atau yang lebih baru Java 2.29.2
Proses ini menggunakan templat Azure Resource Manager (templat ARM) untuk membuat sumber daya Azure Bot untuk bot Anda.
Jika Anda tidak memiliki templat saat ini, buat salinan di proyek bot Anda dari folder deploymentTemplates : C#, JavaScript, Python, atau Java.
Tip
Ini adalah bagian dari proses yang lebih besar untuk menyediakan dan menerbitkan bot. Lihat cara Memprovisikan dan menerbitkan bot untuk daftar lengkap prasyarat.
Mengedit file parameter
Edit file parameter untuk templat ARM agar berisi nilai yang ingin Anda gunakan.
Penting
Anda harus menggunakan nilai dan appId
yang sama appType
saat membuat sumber daya App Service dan Azure Bot.
Jika proyek Anda belum berisi file templat dan parameter ARM terbaru, Anda dapat menyalinnya dari repositori SDK Kerangka Kerja Bot untuk bahasa Anda: C#, JavaScript, Python, atau Java.
Tabel ini menjelaskan parameter penyebaran dalam file parameter, untuk digunakan dengan parameters
opsi perintah.
Secara default, nama file parameter parameters-for-template-AzureBot-with-rg.json.
Parameter | Jenis | Deskripsi |
---|---|---|
azureBotId |
String | Harus diisi. Handel yang unik dan tidak dapat diubah secara global untuk bot Anda, seperti ContosoCustomerService . |
azureBotSku |
String | Opsional. SKU sumber daya Azure Bot. Nilai yang diizinkan: "F0" (gratis) dan "S1" (standar). Defaultnya adalah "S1". |
azureBotRegion |
String | Opsional. Lokasi Azure Bot. Nilai yang diizinkan: "global", "westeurope", "westus" dan "centralindia". Defaultnya adalah "global". |
botEndpoint |
String | Opsional. Titik akhir olahpesan untuk bot Anda, seperti https://<appServiceName>.azurewebsites.net/api/messages . |
appType |
String | Harus diisi. Bagaimana identitas sumber daya bot Anda dikelola. Nilai yang diizinkan adalah: "MultiTenant", "SingleTenant", dan "UserAssignedMSI". Defaultnya adalah "MultiTenant". |
appId |
String | Harus diisi. ID klien atau ID aplikasi dari sumber daya identitas yang Anda buat sebelumnya. Ini adalah ID aplikasi Microsoft dari layanan aplikasi. |
UMSIName |
String | Opsional. Untuk jenis aplikasi identitas terkelola yang ditetapkan pengguna, nama sumber daya identitas. |
UMSIResourceGroupName |
String | Opsional. Untuk jenis aplikasi identitas terkelola yang ditetapkan pengguna, grup sumber daya untuk sumber daya identitas. |
tenantId |
String | Opsional. Untuk identitas terkelola yang ditetapkan pengguna dan jenis aplikasi penyewa tunggal, ID penyewa ID Microsoft Entra untuk sumber daya identitas. |
Tip
Titik akhir olahpesan bot harus diatur sebelum bot yang diterbitkan dapat menerima pesan.
Tidak semua parameter berlaku untuk semua jenis aplikasi.
Berikan nilai untuk UMSIName
, UMSIResourceGroupName
, dan tenantId
.
Membuat sumber daya Azure Bot
Untuk membuat sumber daya Azure Bot untuk bot Anda, gunakan perintah berikut.
az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Opsi | Deskripsi |
---|---|
grup sumber daya | Nama grup sumber daya Azure untuk membuat App Service. |
file templat | Jalur ke templat ARM untuk App Service. Jalurnya bisa relatif atau absolut. |
parameter | Jalur ke file parameter yang akan digunakan dengan templat ARM. Jalurnya bisa relatif atau absolut. |
Untuk proyek yang dibuat dengan generator terbaru, templat ARM dan file parameter terletak di folder DeploymentTemplates\DeployUseExistResourceGroup dalam proyek. Nama file default template-AzureBot-with-rg.json dan parameters-for-template-AzureBot-with-rg.json.
Untuk memperbarui sumber daya Azure Bot Anda
Untuk menambahkan atau memperbarui titik akhir olahpesan untuk Azure Bot Anda, gunakan perintah berikut.
az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Opsi | Deskripsi |
---|---|
grup sumber daya | Nama grup sumber daya Azure yang berisi App Service. |
nama | Handel yang unik dan tidak dapat diubah secara global untuk bot Anda. |
titik akhir | Titik akhir olahpesan untuk bot Anda, seperti https://<appServiceName>.azurewebsites.net/api/messages . |
Informasi Tambahan
Untuk informasi selengkapnya tentang templat ARM, lihat Apa itu templat ARM? dan Cara menggunakan templat penyebaran Azure Resource Manager (ARM) dengan Azure CLI.
Langkah berikutnya
Jika Anda membuat App Service sebagai bagian dari penyebaran bot, lihat Membuat sumber daya dengan templat ARM untuk melanjutkan proses.