Mulai cepat - Membuat dan Mengelola alur kerja dengan Azure CLI di Azure Logic Apps

Artikel
01/04/2024

Berlaku pada: Azure Logic Apps (Konsumsi)

Mulai cepat ini memperlihatkan cara membuat dan mengelola alur kerja otomatis yang berjalan di Azure Logic Apps dengan menggunakan ekstensi Azure CLI Logic Apps (az logic). Dari baris perintah, Anda dapat membuat aplikasi logika Konsumsi di Azure Logic Apps multi-penyewa dengan menggunakan file JSON untuk definisi alur kerja aplikasi logika. Anda kemudian dapat mengelola aplikasi logika Anda dengan menjalankan operasi seperti list, show (get), update, dan delete dari baris perintah.

Peringatan

Ekstensi Azure Logic Apps CLI saat ini bersifat eksperimental dan tidak tercakup oleh dukungan pelanggan. Gunakan ekstensi CLI ini dengan hati-hati, terutama jika Anda memilih untuk menggunakan ekstensi di lingkungan produksi.

Mulai cepat ini saat ini hanya berlaku untuk alur kerja aplikasi logika Konsumsi yang berjalan di Azure Logic Apps multi-penyewa. Azure CLI saat ini tidak tersedia untuk alur kerja aplikasi logika Standar yang berjalan dalam Azure Logic Apps penyewa tunggal. Untuk mengetahui informasi selengkapnya, tinjau Jenis sumber daya dan perbedaan lingkungan host di Azure Logic Apps.

Jika Anda baru menggunakan Azure Logic Apps, Anda juga dapat mempelajari cara membuat aplikasi logika pertama Anda melalui portal Microsoft Azure, di Visual Studio, dan di Visual Studio Code.

Prasyarat

Akun Azure dengan langganan aktif. Jika Anda tidak memiliki langganan Azure, buatlah akun gratis.
Azure CLI dipasang di komputer lokal Anda.
Ekstensi Azure Logic Apps CLI terpasang di komputer Anda. Untuk memasang ekstensi ini, gunakan perintah ini: az extension add --name logic
Grup sumber daya Azure tempat membuat aplikasi logika Anda.

Pemeriksaan Prasyarat

Sebelum memulai, validasi lingkungan Anda:

Masuk ke portal Microsoft Azure dan pastikan langganan Anda aktif dengan menjalankan az login.
Periksa versi Azure CLI Anda di terminal atau jendela perintah dengan menjalankan az --version. Untuk versi terbaru, lihat catatan rilis terbaru.

Jika Anda tidak memiliki versi terbaru, perbarui penginstalan Anda dengan mengikuti panduan penginstalan sistem operasi atau platform Anda.

Contoh - Membuat grup sumber daya

Jika Anda belum memiliki grup sumber daya untuk aplikasi logika Anda, buat grup dengan perintah az group create. Misalnya, perintah berikut membuat grup sumber daya bernama testResourceGroup di lokasi westus.

az group create --name testResourceGroup --location westus

Output menunjukkan provisioningState sebagai Succeeded saat grup sumber daya Anda berhasil dibuat:

<...>
  "name": "testResourceGroup",
  "properties": {
    "provisioningState": "Succeeded"
  },
<...>

Definisi alur kerja

Sebelum Anda membuat aplikasi logika baru atau memperbarui aplikasi logika yang sudah ada dengan menggunakan Azure CLI, Anda memerlukan definisi alur kerja untuk aplikasi logika Anda. Di portal Microsoft Azure, Anda dapat melihat definisi alur kerja yang mendasari aplikasi logika Anda dalam format JSON dengan beralih dari tampilan Perancang ke tampilan Kode.

Saat Anda menjalankan perintah untuk membuat atau memperbarui aplikasi logika Anda, definisi alur kerja Anda diunggah sebagai parameter yang diperlukan (--definition). Anda harus membuat definisi alur kerja Sebagai file JSON yang mengikuti skema Bahasa Definisi Alur Kerja.

Membuat aplikasi logika dari CLI

Untuk membuat alur kerja aplikasi logika dari Azure CLI, gunakan perintah az logic workflow create dengan file JSON untuk definisi tersebut.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--integration-service-environment]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Perintah Anda harus menyertakan parameter yang diperlukan berikut:

Parameter	Nilai	Deskripsi
Definisi alur kerja	`--definition`	File JSON dengan definisi alur kerja aplikasi logika Anda.
Lokasi	`--location -l`	Wilayah Azure tempat aplikasi logika Anda berada.
Nama	`--name -n`	Nama aplikasi logika Anda. Nama hanya dapat berisi huruf, angka, tanda hubung (`-`), garis bawah (`_`), tanda kurung (`()`), dan titik (`.`). Namanya juga harus unik di seluruh wilayah.
Nama grup sumber daya	`--resource-group -g`	Grup sumber daya Azure tempat yang Anda inginkan untuk membuat aplikasi logika Anda. Buat grup sumber daya sebelum memulai jika Anda belum memilikinya untuk aplikasi logika Anda.

Anda juga dapat menyertakan parameter opsional tambahan untuk mengonfigurasi kontrol akses aplikasi, titik akhir, akun integrasi, lingkungan layanan integrasi, status, dan tag sumber daya aplikasi logika Anda.

Contoh - Membuat aplikasi logika

Dalam contoh ini, alur kerja bernama testLogicApp dibuat dalam grup sumber daya testResourceGroup di lokasi westus. File JSON testDefinition.json berisi definisi alur kerja.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "testDefinition.json"

Saat alur kerja Anda berhasil dibuat, CLI memperlihatkan kode JSON definisi alur kerja baru Anda. Jika pembuatan alur kerja Anda gagal, lihat daftar kemungkinan kesalahan.

Memperbarui aplikasi logika dari CLI

Untuk memperbarui alur kerja aplikasi logika dari Azure CLI, gunakan perintah az logic workflow create.

Perintah Anda harus menyertakan parameter yang diperlukan yang sama seperti saat Anda membuat aplikasi logika. Anda juga dapat menambahkan parameter opsional yang sama seperti saat membuat aplikasi logika.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--integration-service-environment]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Contoh - Perbarui aplikasi logika

Dalam contoh ini, alur kerja sampel yang dibuat di bagian sebelumnya diperbarui untuk menggunakan file definisi JSON yang berbeda, newTestDefinition.json, dan menambahkan dua tag sumber daya, testTag1 dan testTag2 dengan nilai deskripsi.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "newTestDefinition.json" --tags "testTag1=testTagValue1" "testTag2=testTagValue"

Saat alur kerja Anda berhasil diperbarui, CLI memperlihatkan definisi alur kerja aplikasi logika Anda yang diperbarui. Jika pembaruan Anda gagal, lihat daftar kemungkinan kesalahan.

Menghapus aplikasi logika dari CLI

Untuk menghapus alur kerja aplikasi logika dari Azure CLI, gunakan perintah az logic workflow delete.

Perintah Anda harus menyertakan parameter yang diperlukan berikut:

Parameter	Nilai	Deskripsi
Nama	`--name -n`	Nama aplikasi logika Anda.
Nama grup sumber daya	`-resource-group -g`	Grup sumber daya tempat aplikasi logika Anda berada.

Anda juga dapat menyertakan parameter opsional untuk melewati permintaan konfirmasi, --yes -y.

az logic workflow delete --name
                         --resource-group
                         [--yes]

CLI kemudian meminta Anda untuk mengonfirmasi penghapusan aplikasi logika Anda. Anda dapat melewati permintaan konfirmasi dengan menggunakan parameter opsional --yes -y dengan perintah Anda.

Are you sure you want to perform this operation? (y/n):

Untuk mengonfirmasi penghapusan aplikasi logika, cantumkan aplikasi logika Anda di CLI, atau lihat aplikasi logika Anda di portal Microsoft Azure.

Contoh - Menghapus aplikasi logika

Dalam contoh ini, alur kerja sampel yang dibuat di bagian sebelumnya dihapus.

az logic workflow delete --resource-group "testResourceGroup" --name "testLogicApp"

Setelah Anda menanggapi permintaan konfirmasi dengan y, aplikasi logika dihapus.

Pertimbangan - Menghapus aplikasi logika

Menghapus aplikasi logika memengaruhi instans alur kerja dengan cara berikut:

Azure Logic Apps melakukan upaya terbaik untuk membatalkan proses dan pending run.

Bahkan dengan volume besar atau backlog, sebagian besar eksekusi dibatalkan sebelum selesai atau dimulai. Namun, proses pembatalan mungkin membutuhkan waktu untuk menyelesaikannya. Sementara itu, beberapa eksekusi mungkin akan dijemput untuk dieksekusi sementara runtime bekerja melalui proses pembatalan.
Azure Logic Apps tidak membuat atau menjalankan instans alur kerja baru.
Jika Anda menghapus alur kerja lalu membuat ulang alur kerja yang sama, alur kerja yang dibuat ulang tidak akan memiliki metadata yang sama dengan alur kerja yang dihapus. Anda harus menyimpan ulang alur kerja mana pun yang memanggil alur kerja yang dihapus. Dengan begitu, pemanggil mendapatkan informasi yang benar untuk alur kerja yang dibuat ulang. Jika tidak, panggilan ke alur kerja yang dibuat ulang gagal dengan kesalahan Unauthorized. Perilaku ini juga berlaku untuk alur kerja yang menggunakan artefak dalam akun integrasi dan alur kerja yang memanggil fungsi Azure.

Tampilkan aplikasi logika di CLI

Untuk mendapatkan alur kerja aplikasi logika tertentu, gunakan perintah az logic workflow show.

az logic workflow show --name
                       --resource-group

Perintah Anda harus menyertakan parameter yang diperlukan berikut

Parameter	Nilai	Deskripsi
Nama	`--name -n`	Nama aplikasi logika Anda.
Nama grup sumber daya	`--resource-group -g`	Nama grup sumber daya tempat aplikasi logika berada.

Contoh - Dapatkan aplikasi logika

Dalam contoh ini, aplikasi logika testLogicApp dalam grup sumber daya testResourceGroup dikembalikan dengan log lengkap untuk penelusuran kesalahan.

az logic workflow show --resource-group "testResourceGroup" --name "testLogicApp" --debug

Mencantumkan aplikasi logika di CLI

Untuk mencantumkan aplikasi logika Anda berdasarkan langganan, gunakan perintah az logic workflow list. Perintah ini mengembalikan kode JSON untuk alur kerja aplikasi logika Anda.

Anda dapat memfilter hasil dengan parameter opsional berikut:

Parameter	Nilai	Deskripsi
Nama grup sumber daya	`--resource-group -g`	Nama grup sumber daya yang ingin Anda filter hasilnya.
Jumlah item	`--top`	Jumlah item yang disertakan dalam hasil Anda.
Filter	`--filter`	Tipe filter yang Anda gunakan di daftar Anda. Anda dapat memfilter menurut status (`State`), pemicu (`Trigger`) dan pengidentifikasi sumber daya yang direferensikan (`ReferencedResourceId`).

az logic workflow list [--filter]
                       [--resource-group]
                       [--top]

Contoh - Daftar aplikasi logika

Dalam contoh ini, semua alur kerja yang diaktifkan dalam grup sumber daya testResourceGroup dikembalikan dalam format tabel ASCII.

az logic workflow list --resource-group "testResourceGroup" --filter "(State eq 'Enabled')" --output "table"

Kesalahan

Kesalahan berikut menunjukkan bahwa ekstensi Azure Logic Apps CLI belum terpasang. Ikuti langkah-langkah dalam prasyarat untuk memasang ekstensi Azure Logic Apps di komputer Anda.

az: 'logic' is not in the 'az' command group. See 'az --help'. If the command is from an extension, please make sure the corresponding extension is installed. To learn more about extensions, please visit https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview

Kesalahan berikut mungkin menunjukkan bahwa jalur file untuk mengunggah definisi alur kerja Anda salah.

Expecting value: line 1 column 1 (char 0)

Parameter global

Anda bisa menggunakan parameter Azure CLI global opsional berikut ini dengan az logic perintah Anda:

Parameter	Nilai	Deskripsi
Format output	`--output -o`	Ubah format output dari JSON default.
Hanya menampilkan kesalahan	`--only-show-errors`	Tekan peringatan dan hanya tampilkan kesalahan.
Verbose	`--verbose`	Tampilkan log verbose.
Debug	`--debug`	Tampilkan semua log debug.
Pesan bantuan	`--help -h`	Tampilkan dialog bantuan.
Kueri	`--query`	Atur string kueri JMESPath untuk output JSON.

Langkah berikutnya

Untuk informasi lebih tentang Azure CLI, lihat dokumentasi Azure CLI.

Anda dapat menemukan sampel skrip Azure Logic Apps CLI tambahan di browser sampel kode Microsoft.

Selanjutnya, Anda dapat membuat contoh logika aplikasi melalui Azure CLI menggunakan contoh skrip dan definisi alur kerja.

Membuat aplikasi logika menggunakan skrip sampel.

Share via