Buat parameter lintas lingkungan untuk input alur kerja di Azure Logic Apps

Berlaku pada: Azure Logic Apps (Konsumsi + Standar)

Dalam Azure Logic Apps, Anda dapat membuat nilai abstrak yang dapat berubah dalam alur kerja Anda di lingkungan pengembangan, pengujian, dan produksi Anda dengan menentukan parameter. Saat Anda menggunakan parameter sebagai gantinya, Anda dapat lebih fokus pada mendesain alur kerja Anda, dan menyisipkan variabel spesifik-lingkungan Anda nanti.

Artikel ini memperkenalkan cara membuat, menggunakan, dan mengedit parameter untuk alur kerja aplikasi logika Konsumsi multipenyewa dan untuk alur kerja aplikasi logika Standar penyewa tunggal. Anda juga akan belajar cara mengelola variabel lingkungan.

Untuk informasi selengkapnya tentang multipenyewa versus penyewa tunggal Azure Logic Apps, tinjau Penyewa tunggal versus multipenyewa dan lingkungan layanan integrasi.

Prasyarat

• Akun dan langganan Azure. Jika Anda tidak memiliki langganan, daftar untuk mendapatkan akun Azure secara gratis.

• Alur kerja aplikasi logika Konsumsi atau Standar

  Jika Anda belum memiliki alur kerja aplikasi logika, lihat Membuat contoh alur kerja aplikasi logika Konsumsi menggunakan portal Azure atau Membuat contoh alur kerja aplikasi logika Standar menggunakan portal Azure.

  Catatan

  Saat ini, Anda dapat membuat parameter untuk alur kerja aplikasi logika Konsumsi hanya dengan menggunakan portal Microsoft Azure. Anda dapat membuat parameter untuk alur kerja aplikasi logika standar hanya dengan menggunakan portal Microsoft Azure atau Visual Studio Code.

Parameter untuk Konsumsi versus alur kerja aplikasi logika standar

Untuk alur kerja aplikasi logika Konsumsi dan Standar, Anda dapat menentukan parameter menggunakan desainer. Setelah Anda menentukan parameter, Anda dapat mereferensikan parameter tersebut dari alur kerja atau koneksi apa pun yang ada dalam sumber daya aplikasi logika yang sama.

Namun, dalam layanan multipenyewa, setelah Anda membuat dan menggunakan parameter dalam desainer, Anda menentukan dan mengatur variabel lingkungan dalam templat Azure Resource Manager (templat ARM) dan file parameter templat Anda. Dalam skenario ini, Anda harus menentukan dan mengatur parameter pada penyebaran, yang berarti bahwa jika Anda harus mengubah satu variabel saja, Anda tetap harus menyebarkan ulang templat ARM aplikasi logika Anda.

Di Azure Logic Apps penyewa tunggal, Anda dapat bekerja dengan variabel lingkungan baik pada waktu runtime maupun waktu penyebaran dengan menggunakan parameter dan pengaturan aplikasi. Di Azure Logic Apps penyewa tunggal, pengaturan aplikasi berisi opsi konfigurasi global untuk semua alur kerja dalam aplikasi logika yang sama. Untuk informasi selengkapnya, tinjau Mengedit pengaturan host dan aplikasi untuk aplikasi logika berbasis penyewa tunggal.

Catatan

Pada alur kerja aplikasi logika Standar, jenis data aman, seperti securestring dan secureobject, tidak didukung. Namun, sebagai opsi alternatif, Anda dapat menggunakan pengaturan aplikasi dengan Azure Key Vault. Anda kemudian dapat langsung mereferensikan string aman, seperti string dan kunci koneksi. Mirip dengan templat ARM, tempat Anda dapat menentukan variabel lingkungan pada waktu penyebaran, Anda dapat menentukan pengaturan aplikasi dalam definisi alur kerja aplikasi logika Anda. Anda kemudian dapat mengambil nilai infrastruktur yang dihasilkan secara dinamis, seperti titik akhir koneksi, string penyimpanan, dan banyak lagi.

Namun, pengaturan aplikasi memiliki batasan ukuran dan tidak dapat direferensikan dari area tertentu di Azure Logic Apps. Parameter menawarkan rentang kasus penggunaan yang lebih luas daripada pengaturan aplikasi, seperti dukungan untuk ukuran nilai besar dan objek yang kompleks.

Misalnya, jika Anda menggunakan Visual Studio Code sebagai alat pengembangan lokal untuk menjalankan alur kerja secara lokal, dalam proyek aplikasi logika Anda, Anda dapat menentukan parameter menggunakan file parameters.json. Anda lalu dapat mereferensikan parameter apa pun dalam file parameter ini dari alur kerja apa pun dalam file workflow.json proyek Anda atau dari objek koneksi dalam file connections.json proyek Anda. Daftar berikut menjelaskan beberapa kasus yang umum digunakan:

• Memiliki file parameter pengujian yang mencakup semua nilai yang Anda gunakan selama pengujian. Pada penyebaran, Anda dapat mengganti file parameter pengujian dengan file parameter produksi Anda.

• Parametrisasi bagian berbeda dari file connections.json Anda. Anda kemudian dapat memeriksa file connections.json ke kontrol sumber, lalu mengelola koneksi apa pun melalui file parameter.json Anda.

• Anda juga dapat membuat parameter objek kompleks, seperti objek JSON authentication. Misalnya, ganti nilai objek authentication dengan string yang membawa ekspresi parameter tunggal, seperti @parameters('api-auth').

• Tinjau dan edit pengaturan aplikasi dalam file local.settings.json proyek Anda. Anda kemudian dapat mereferensikan pengaturan aplikasi ini di parameter Anda.

Catatan

Sebagai rekomendasi umum, pertimbangkan untuk menggunakan parameter sebagai cara default untuk membuat parameter nilai, bukan pengaturan aplikasi. Dengan demikian, ketika Anda perlu menyimpan kunci atau string aman, Anda dapat mengikuti rekomendasi untuk mereferensikan pengaturan aplikasi dari parameter Anda. Jika mau, Anda dapat menggunakan kedua opsi di solusi Anda dengan menggunakan parameter untuk mereferensikan pengaturan app.

Menentukan, menggunakan, dan mengedit parameter

Consumption

Portal Azure

1. Di portal Microsoft Azure, buka sumber daya aplikasi logika Anda. Di bawah Alur kerja, pilih dan buka alur kerja di dalam desainer.

2. Di bar alat desainer, pilih Parameter.

   

3. Di panel Parameter, pilih Tambahkan parameter.

4. Berikan informasi berikut tentang parameter untuk dibuat:

   Properti	Diperlukan	Deskripsi
   Nama	Ya	Nama untuk parameter yang akan dibuat.
   Jenis	Ya	Jenis data untuk parameter, seperti Array, Bool, Float, Int, Object, Secure Object, Secure String, dan String.
   Nilai Default	Ya	Nilai default untuk parameter. Anda harus menentukan nilai parameter karena logika alur kerja, informasi koneksi, dan nilai parameter tidak berada di satu lokasi. Desainer harus dapat menyelesaikan nilai parameter sebelum memuat. Penting: Untuk tipe data Secure Object dan Secure String, hindari pengaturan nilai default karena nilai disimpan sebagai teks biasa.
   Nilai Aktual	Tidak	Nilai sebenarnya untuk parameter.

   Contoh berikut menunjukkan definisi untuk parameter string:

   

5. Jika Anda memiliki lebih banyak parameter untuk ditambahkan, pilih Tambahkan Parameter. Jika tidak, tutup panel parameter, tetapi pastikan untuk menyimpan alur kerja untuk menyimpan definisi parameter baru Anda.

6. Untuk mereferensikan parameter dari pemicu atau tindakan yang ada dalam alur kerja yang sama, ikuti langkah-langkah berikut:

   1. Dalam desainer, buka alur kerja yang Anda inginkan, dan perluas pemicu atau tindakan.

   2. Di properti tempat Anda ingin menggunakan parameter, klik di dalam kotak edit properti itu.

   3. Dari daftar konten dinamis yang terbuka, di bawah Parameters, pilih parameter yang sebelumnya Anda buat, misalnya:

      

7. Untuk melihat atau mengedit parameter dalam alur kerja aplikasi logika, ikuti langkah-langkah berikut:

   1. Buka alur kerja aplikasi logika Anda di desainer. Di bar alat desainer, pilih Parameter.

      Panel Parameter membuka dan menampilkan semua parameter yang Anda tentukan dari alur kerja di aplikasi logika itu.

   2. Buat pengeditan Anda, tutup panel parameter, dan simpan alur kerja aplikasi logika Anda.

Standard

portal Microsoft Azure

1. Di portal Microsoft Azure, buka sumber daya aplikasi logika Anda. Di bawah Alur kerja, buka alur kerja di dalam desainer.

2. Di bar alat desainer, pilih Parameter.

   

3. Di panel Parameter, pilih Buat parameter.

4. Berikan informasi berikut tentang parameter untuk dibuat:

   Properti	Diperlukan	Deskripsi
   Nama	Ya	Nama untuk parameter yang akan dibuat.
   Jenis	Ya	Jenis data untuk parameter, seperti Array, Bool, Float, Int, Object, dan String. Catatan: Pada alur kerja berbasis penyewa tunggal, jenis data aman, seperti securestring dan secureobject, tidak didukung.
   Nilai	Ya	Nilai untuk parameter. Dalam alur kerja aplikasi logika Standar, Anda harus menentukan nilai parameter karena logika alur kerja, informasi koneksi, dan nilai parameter tidak berada di satu lokasi. Desainer harus dapat menyelesaikan nilai parameter sebelum memuat.

   Contoh berikut menunjukkan definisi untuk parameter string:

   

5. Saat Anda selesai, tutup panel Parameter, tetapi pastikan untuk menyimpan alur kerja untuk menyimpan definisi parameter baru Anda.

6. Untuk mereferensikan parameter dari pemicu atau tindakan yang ada dalam alur kerja apa pun dalam aplikasi logika yang sama, ikuti langkah-langkah berikut:

   1. Dalam desainer, buka alur kerja yang Anda inginkan, dan perluas pemicu atau tindakan.

   2. Di properti tempat Anda ingin menggunakan parameter, klik di dalam kotak edit properti itu.

   3. Dari daftar konten dinamis yang terbuka, di bawah Parameters, pilih parameter yang sebelumnya Anda buat, misalnya:

      

7. Untuk melihat atau mengedit parameter di aplikasi logika yang sama, ikuti salah satu langkah berikut:

   • Buka alur kerja apa pun dalam aplikasi logika itu. Pada menu alur kerja, pilih Desainer. Di bar alat desainer, pilih Parameter.

     Panel Parameter membuka dan menampilkan semua parameter yang Anda tentukan dari alur kerja di aplikasi logika itu.

   • Untuk melihat atau mengedit JSON massal, pada menu utama aplikasi logika Anda, pilih Parameter.

     Tampilan JSON Parameter membuka dan menampilkan semua parameter yang Anda tentukan dari alur kerja di dalam aplikasi logika itu.

Visual Studio Code

1. Dalam file JSON level-akar proyek yang dinamai parameters.json, tentukan semua parameter dan nilainya. File ini memiliki objek yang mencakup pasangan kunci-nilai. Setiap kunci adalah nama untuk setiap parameter, sementara setiap nilai adalah struktur untuk setiap parameter. Setiap struktur perlu mencakup deklarasi type dan value.

   Penting

   File parameters.json Anda harus menentukan dan menyertakan semua parameter dan nilai-nilainya yang Anda rujuk atau gunakan di tempat lain dalam proyek Anda, misalnya, dalam definisi atau koneksi alur kerja.

   Contoh berikut menunjukkan file parameter dasar:

   {
       "responseString": { 
           "type": "string", 
           "value": "hello" 
       },
       "functionAuth": { 
           "type": "object", 
           "value": { 
               "type": "QueryString", 
               "name": "Code", 
               "value": "@appsetting('<AzureFunctionsOperation-FunctionAppKey>')" 
           }
       }
    }
   

   Catatan

   Dalam file parameters.json, @appsetting adalah satu-satunya jenis ekspresi yang valid.

2. Untuk mereferensikan parameter dalam input pemicu atau tindakan Anda, gunakan ekspresi @parameters('<parameter-name>').

Parametrisasi file koneksi

Untuk memparameterkan file sambungan.json Anda, ganti nilai untuk literal, seperti ConnectionRuntimeUrl, dengan ekspresi parameters() tunggal, misalnya, @parameters('api-runtimeUrl'). Dalam file connections.json satu-satunya jenis ekspresi yang valid adalah @parameters dan @appsetting.

Penting

Jika Anda membuat parameter file connections.json, selama pengembangan, pengalaman desainer menjadi terbatas, baik secara lokal maupun di portal Microsoft Azure. Jika Anda perlu menggunakan desainer untuk pengembangan, sebaiknya gunakan file connections.json yang tidak berparameter. Kemudian, dalam alur penyebaran Anda, ganti dengan file yang diparameterkan. Runtime masih berfungsi dengan parameterisasi. Peningkatan desainer sedang dalam pengembangan.

Contoh berikut menunjukkan file berparameter connections.json yang menggunakan pengaturan aplikasi dan parameter. Meskipun Anda ingin menggunakan parameter jika memungkinkan, skenario ini adalah pengecualian atau kasus tepi, di mana Anda akan menggunakan pengaturan aplikasi atas parameter karena pengaturan aplikasi dihasilkan selama penyebaran dan lebih mudah untuk mengisi secara dinamis dalam alur pengembangan. File sampel ini menggunakan parameter untuk objek autentikasi kompleks blob_auth dan pengaturan aplikasi untuk nilai lainnya. Dalam hal ini, Anda dapat menggunakan parameter untuk objek autentikasi, karena Anda tidak mungkin merujuk ke parameter dalam alur kerja Anda:

{
   "serviceProviderConnections": {
      "serviceBus": {
         "parameterValues": {
            "connectionString": "@appsetting('serviceBus_connectionString')"
        },
        "serviceProvider": {
           "id": "/serviceProviders/serviceBus"
        },
        "displayName": "servicebus"
     }
   },
   "managedApiConnections": {
      "azureblob": {
         "api": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/providers/Microsoft.Web/locations/@{appsetting('WORKFLOWS_LOCATION_NAME')}/managedApis/azureblob"
         },
         "connection": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/resourceGroups/@{appsetting('WORKFLOWS_RESOURCE_GROUP_NAME')}/providers/Microsoft.Web/connections/azureblob"
         },
         "connectionRuntimeUrl": "@appsetting('BLOB_CONNECTION_RUNTIMEURL')",
         "authentication": "@parameters('blob_auth')"
      }
   }
}

Catatan

Bila Anda memiliki ekspresi yang sejalan dengan teks biasa, pastikan untuk menggunakan format interpolasi untuk ekspresi itu dengan melampirkan ekspresi itu menggunakan kurung kurawal ({}). Format ini membantu menghindari masalah penguraian.

Misalnya, jika Anda memiliki "<text>/@<function-name>('<parameter-name>')/<text>", gunakan versi berikut sebagai gantinya: "<text>/@{<function-name>('<parameter-name>')}/<text>".

Untuk informasi selengkapnya, tinjau Pertimbangan untuk menggunakan fungsi.

Mengelola file parameter

Biasanya, Anda perlu mengelola beberapa versi file parameter. Anda mungkin memiliki nilai yang ditargetkan untuk lingkungan penyebaran yang berbeda, seperti pengembangan, pengujian, dan produksi. Mengelola file parameter ini sering kali berjalan seperti mengelola file parameter templat ARM. Saat Anda menyebarkan ke lingkungan tertentu, Anda mempromosikan file parameter yang sesuai, umumnya melalui alur untuk Azure DevOps.

Untuk mengganti file parameter secara dinamis menggunakan Azure CLI, jalankan perintah berikut:

az functionapp deploy --resource-group MyResourceGroup --name MyLogicApp --src-path C:\parameters.json --type static --target-path parameters.json

Jika memiliki proyek Logic App berbasis NuGet, Anda harus memperbarui file proyek Anda ( <logic-app-name>.csproj) untuk menyertakan file parameter dalam output bangun, misalnya:

<ItemGroup>
  <None Update="parameters.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

Catatan

Saat ini, kemampuan untuk mengganti file parameter secara dinamis belum tersedia di portal Microsoft Azure atau desainer alur kerja.

Untuk informasi selengkapnya tentang menyiapkan aplikasi logika Anda untuk penyebaran Azure DevOps, lihat dokumentasi berikut ini:

• Ringkasan penyebaran DevOps untuk aplikasi logika berbasis penyewa tunggal
• Menyiapkan penyebaran Azure DevOps untuk aplikasi logika berbasis penyewa tunggal

Mengelola pengaturan aplikasi

Di Azure Logic Apps penyewa tunggal, pengaturan aplikasi berisi opsi konfigurasi global untuk semua alur kerja dalam aplikasi logika yang sama. Saat Anda menjalankan alur kerja secara lokal di Visual Studio Code, Anda dapat mengakses pengaturan aplikasi ini dapat sebagai variabel lingkungan lokal di file local.settings.json. Anda kemudian dapat mereferensikan pengaturan aplikasi ini di parameter Anda.

Untuk menambahkan, memperbarui, atau menghapus pengaturan aplikasi, pilih dan ulas bagian berikut untuk templat Visual Studio Code, portal Azure, Azure CLI, atau ARM (Bicep).

portal Microsoft Azure

Untuk meninjau pengaturan aplikasi untuk aplikasi logika Anda di portal Microsoft Azure, ikuti langkah berikut:

1. Di portal Microsoft Azure, buka sumber daya aplikasi logika Anda.

2. Pada menu aplikasi logika, di bawah Pengaturan, pilih Konfigurasi.

3. Pada halaman Konfigurasi, pada tab Pengaturan aplikasi, ulas pengaturan aplikasi untuk aplikasi logika Anda.

4. Untuk menampilkan semua nilai, pilih Tampilkan Nilai. Atau, untuk menampilkan satu nilai, pilih nilai tersebut.

Untuk menambahkan pengaturan baru, ikuti langkah berikut:

1. Pada tab Pengaturan aplikasi, pada Pengaturan aplikasi, pilih Pengaturan aplikasi baru.

2. Untuk Nama, masukkan kunci atau nama untuk pengaturan baru Anda.

3. Untuk Nilai, masukkan nilai untuk pengaturan baru Anda.

4. Saat Anda siap untuk membuat pasangan kunci-nilai baru, pilih OK.

   

5. Setelah selesai, di toolbar Konfigurasi, pilih Simpan.

Azure CLI

Untuk mengulas pengaturan aplikasi Anda saat ini menggunakan Azure CLI, jalankan perintah, az logicapp config appsettings list. Pastikan perintah Anda menyertakan parameter --name -n dan --resource-group -g, misalnya:

az logicapp config appsettings list --name MyLogicApp --resource-group MyResourceGroup

Untuk menambahkan atau memperbarui pengaturan aplikasi menggunakan Azure CLI, jalankan perintah az logicapp config appsettings set. Pastikan bahwa perintah Anda mencakup parameter --name n and --resource-group -g. Misalnya, perintah berikut membuat pengaturan dengan kunci bernama CUSTOM_LOGIC_APP_SETTING dengan nilai 12345:

az logicapp config appsettings set --name MyLogicApp --resource-group MyResourceGroup --settings CUSTOM_LOGIC_APP_SETTING=12345 

Templat Resource Manager atau Bicep

Untuk meninjau dan menentukan pengaturan aplikasi Anda di templat ARM atau Bicep, temukan definisi sumber daya aplikasi logika Anda, dan perbarui objek JSON appSettings. Untuk definisi sumber daya lengkap, lihat referensi templat ARM.

Contoh ini menunjukkan pengaturan file baik untuk templat ARM atau Bicep:

"appSettings": [
    {
        "name": "string",
        "value": "string"
    },
    {
        "name": "string",
        "value": "string"
    },
    <...>
], 

Langkah berikutnya

• Lingkungan penyewa tunggal versus multi penyewa dan layanan integrasi untuk Azure Logic Apps