Mengelola grup variabel

Layanan Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019

Artikel ini menjelaskan cara membuat dan menggunakan grup variabel di Azure Pipelines. Grup variabel menyimpan nilai dan rahasia yang dapat Anda teruskan ke alur YAML atau menyediakan di beberapa alur dalam proyek.

Variabel rahasia dalam grup variabel adalah sumber daya yang dilindungi. Anda dapat menambahkan kombinasi persetujuan, pemeriksaan, dan izin alur untuk membatasi akses ke variabel rahasia dalam grup variabel. Akses ke variabel nonsecret tidak dibatasi oleh persetujuan, pemeriksaan, atau izin alur.

Grup variabel mengikuti model keamanan pustaka untuk peran dan izin.

Prasyarat

• Organisasi dan proyek Azure DevOps Services tempat Anda memiliki izin untuk membuat alur dan variabel.
• Proyek di organisasi Azure DevOps atau koleksi Azure DevOps Server Anda. Buat proyek jika Anda tidak memilikinya.
• Jika Anda menggunakan Azure DevOps CLI, Anda memerlukan Azure CLI versi 2.30.0 atau yang lebih tinggi dengan ekstensi Azure DevOps CLI. Untuk informasi selengkapnya, lihat Mulai menggunakan Azure DevOps CLI.

Menyiapkan ASDK

Jika Anda menggunakan Azure DevOps CLI, Anda perlu menyiapkan CLI untuk bekerja dengan organisasi dan proyek Azure DevOps Anda.

1. Masuk ke organisasi Azure DevOps Anda dengan menggunakan perintah az login .

   az login
   

2. Jika diminta, pilih langganan Anda dari daftar yang ditampilkan di jendela terminal Anda.

3. Pastikan Anda menjalankan versi terbaru Azure CLI dan ekstensi Azure DevOps dengan menggunakan perintah berikut.

   az upgrade
   az extension add --name azure-devops --upgrade
   

4. Dalam perintah Azure DevOps CLI, Anda dapat mengatur organisasi dan proyek default dengan menggunakan:

   az devops configure --defaults organization=<YourOrganizationURL> project=<Project Name or ID>`
   

   Jika Anda belum mengatur organisasi dan proyek default, Anda dapat menggunakan detect=true parameter dalam perintah Anda untuk mendeteksi konteks organisasi dan proyek secara otomatis berdasarkan direktori Anda saat ini. Jika default tidak dikonfigurasi atau terdeteksi, Anda perlu secara eksplisit menentukan org parameter dan project dalam perintah Anda.

Membuat grup variabel

Anda dapat membuat grup variabel untuk eksekusi alur di proyek Anda.

Catatan

Untuk membuat grup variabel rahasia untuk menautkan rahasia dari brankas kunci Azure sebagai variabel, ikuti instruksi di Menautkan grup variabel ke rahasia di Azure Key Vault.

Antarmuka Pengguna Azure Pipelines

1. Di proyek Azure DevOps Anda, pilih Pustaka Alur>dari menu sebelah kiri.

2. Pada halaman Pustaka, pilih + Grup variabel.

   

3. Pada halaman grup variabel baru, di bawah Properti, masukkan nama dan deskripsi opsional untuk grup variabel.

4. Di bawah Variabel, pilih + Tambahkan, lalu masukkan nama variabel dan nilai untuk disertakan dalam grup. Jika Anda ingin mengenkripsi dan menyimpan nilai dengan aman, pilih ikon kunci di samping variabel.

5. Pilih + Tambahkan untuk menambahkan setiap variabel baru. Saat Anda selesai menambahkan variabel, pilih Simpan.

   

Anda sekarang dapat menggunakan grup variabel ini dalam alur proyek.

Azure DevOps CLI

Di Azure DevOps Services, Anda dapat membuat grup variabel dengan menggunakan Azure DevOps CLI.

Untuk membuat grup variabel, gunakan perintah az pipelines variable-group create .

Misalnya, perintah berikut membuat grup variabel bernama home-office-config, menambahkan variabel app-location=home-office dan app-name=contoso, dan output menghasilkan format YAML.

az pipelines variable-group create --name home-office-config
                                   --variables app-location=home-office app-name=contoso
                                   --output yaml

Output:

authorized: false
description: null
id: 5
name: home-office-config
providerData: null
type: Vsts
variables:
  app-location:
    isSecret: null
    value: home-office
  app-name:
    isSecret: null
    value: contoso

Memperbarui grup variabel

Antarmuka Pengguna Azure Pipelines

Anda dapat memperbarui grup variabel dengan menggunakan antarmuka pengguna Azure Pipelines.

1. Di proyek Azure DevOps Anda, pilih Pustaka Alur>dari menu sebelah kiri.
2. Pada halaman Pustaka , pilih grup variabel yang ingin Anda perbarui. Anda juga dapat mengarahkan mouse ke atas daftar grup variabel, pilih ikon Opsi lainnya, dan pilih Edit dari menu.
3. Pada halaman grup variabel, ubah salah satu properti, lalu pilih Simpan.

Azure DevOps CLI

Di Azure DevOps Services, Anda dapat memperbarui grup variabel dengan menggunakan Azure DevOps CLI.

Mencantumkan grup variabel

Untuk memperbarui grup variabel atau variabel di dalamnya dengan menggunakan Azure DevOps CLI, Anda menggunakan grup group-idvariabel .

Anda bisa mendapatkan nilai ID grup variabel dari output perintah pembuatan grup variabel, atau menggunakan perintah az pipelines variable-group list .

Misalnya, perintah berikut mencantumkan tiga grup variabel proyek pertama dalam urutan naik dan mengembalikan hasilnya, termasuk ID grup variabel, dalam format tabel.

az pipelines variable-group list --top 3 --query-order Asc --output table

Output:

ID    Name               Type    Number of Variables
----  -----------------  ------  ---------------------
1     myvariables        Vsts    2
2     newvariables       Vsts    4
3     new-app-variables  Vsts    3

Memperbarui grup variabel

Untuk memperbarui grup variabel, gunakan perintah az pipelines variable-group update .

Catatan

Anda tidak dapat memperbarui grup variabel jenis AzureKeyVault menggunakan Azure DevOps CLI.

Misalnya, perintah berikut memperbarui grup variabel dengan ID 4 untuk mengubah name dan description, dan output menghasilkan format tabel.

az pipelines variable-group update --group-id 4
                                   --name my-new-variables
                                   --description "New home office variables"
                                   --output table

Output:

ID    Name              Description               Is Authorized  Number of Variables
----  ----------------  ------------------------- -------------  -------------------
4     my-new-variables  New home office variables false          2

Perlihatkan detail untuk grup variabel

Anda dapat menggunakan perintah az pipelines variable-group show untuk menampilkan detail untuk grup variabel. Misalnya, perintah berikut menunjukkan detail untuk grup variabel dengan ID 4 dan mengembalikan hasil dalam format YAML.

az pipelines variable-group show --group-id 4 --output yaml

Output:

authorized: false
description: Variables for my new app
id: 4
name: my-new-variables
providerData: null
type: Vsts
variables:
  app-location:
    isSecret: null
    value: home-office
  app-name:
    isSecret: null
    value: contoso

Menghapus grup variabel

Antarmuka Pengguna Azure Pipelines

Anda dapat menghapus grup variabel di antarmuka pengguna Azure Pipelines.

1. Di proyek Azure DevOps Anda, pilih Pustaka Alur>dari menu sebelah kiri.
2. Pada halaman Pustaka, arahkan mouse ke atas grup variabel yang ingin Anda hapus dan pilih ikon Opsi lainnya.
3. Pilih Hapus dari menu, lalu pilih Hapus pada layar konfirmasi.

Azure DevOps CLI

Di Azure DevOps Services, Anda dapat menghapus grup variabel dengan menggunakan Azure DevOps CLI.

Untuk menghapus grup variabel, gunakan perintah az pipelines variable-group delete . Misalnya, perintah berikut menghapus grup variabel dengan ID 1 dan tidak meminta konfirmasi.

az pipelines variable-group delete --group-id 1 --yes

Mengelola variabel dalam grup variabel

Antarmuka Pengguna Azure Pipelines

Anda dapat mengubah, menambahkan, atau menghapus variabel dalam grup variabel dengan menggunakan antarmuka pengguna Azure Pipelines.

1. Di proyek Azure DevOps Anda, pilih Pustaka Alur>dari menu sebelah kiri.
2. Pada halaman Pustaka , pilih grup variabel yang ingin Anda perbarui. Anda juga dapat mengarahkan mouse ke atas daftar grup variabel, pilih ikon Opsi lainnya, dan pilih Edit dari menu.
3. Pada halaman grup variabel, Anda dapat:
   • Ubah salah satu nama atau nilai variabel.
   • Hapus salah satu variabel dengan memilih ikon tempat sampah di samping nama variabel.
   • Ubah variabel menjadi rahasia atau nonsecret dengan memilih ikon kunci di samping nilai variabel.
   • Tambahkan variabel baru dengan memilih + Tambahkan.
4. Setelah membuat perubahan, pilih Simpan.

Azure DevOps CLI

Di Azure DevOps Services, Anda dapat mengelola variabel dalam grup variabel dengan menggunakan Azure DevOps CLI.

Mencantumkan variabel dalam grup variabel

Untuk mencantumkan variabel dalam grup variabel, gunakan perintah az pipelines variable-group variable list . Misalnya, perintah berikut mencantumkan semua variabel dalam grup variabel dengan ID 4 dan memperlihatkan hasilnya dalam format tabel.

az pipelines variable-group variable list --group-id 4 --output table

Output:

Name            Is Secret    Value
--------------  -----------  -----------
app-location    False        home-office
app-name        False        contoso

Menambahkan variabel ke grup variabel

Untuk menambahkan variabel ke grup variabel, gunakan perintah az pipelines variable-group create .

Misalnya, perintah berikut membuat variabel baru bernama requires-login dengan nilai true default dalam grup variabel dengan ID 4. Hasilnya diperlihatkan dalam format tabel.

az pipelines variable-group variable create --group-id 4
                                            --name requires-login
                                            --value true
                                            --output table

Output:

Name            Is Secret    Value
--------------  -----------  -------
requires-login  False        true

Memperbarui variabel dalam grup variabel

Untuk memperbarui variabel dalam grup variabel, gunakan perintah az pipelines variable-group variable update .

Catatan

Anda tidak dapat memperbarui variabel dalam grup variabel jenis AzureKeyVault menggunakan Azure DevOps CLI. Anda dapat memperbarui variabel melalui az keyvault perintah.

Misalnya, perintah berikut memperbarui requires-login variabel dengan nilai false baru dalam grup variabel dengan ID 4, dan menunjukkan hasilnya dalam format YAML. Perintah menentukan bahwa variabel adalah secret.

az pipelines variable-group variable update --group-id 4
                                            --name requires-login
                                            --value false
                                            --secret true
                                            --output yaml

Output menunjukkan nilai sebagai null alih-alih false karena itu adalah nilai tersembunyi rahasia.

requires-login:
  isSecret: true
  value: null

Mengelola variabel rahasia

Untuk mengelola variabel rahasia, gunakan perintah az pipelines variable-group variable update dengan parameter berikut:

• secret: Atur ke true untuk menunjukkan bahwa nilai variabel dirahasiakan.
• prompt-value: Atur ke true untuk memperbarui nilai variabel rahasia dengan menggunakan variabel lingkungan atau perintah melalui input standar.
• value: Untuk variabel rahasia, gunakan parameter yang prompt-value akan diminta untuk memasukkan nilai melalui input standar. Untuk konsol noninteraktif, Anda dapat mengambil variabel lingkungan yang diawali dengan AZURE_DEVOPS_EXT_PIPELINE_VAR_. Misalnya, Anda dapat memasukkan variabel bernama MySecret dengan menggunakan variabel AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecretlingkungan .

Menghapus variabel dari grup variabel

Untuk menghapus variabel dari grup variabel, gunakan perintah az pipelines variable-group variable delete . Misalnya, perintah berikut menghapus requires-login variabel dari grup variabel dengan ID 4.

az pipelines variable-group variable delete --group-id 4 --name requires-login

Perintah meminta konfirmasi karena itu adalah default. --yes Gunakan parameter untuk melewati perintah konfirmasi.

Are you sure you want to delete this variable? (y/n): y
Deleted variable 'requires-login' successfully.

Menggunakan grup variabel dalam alur

Anda dapat menggunakan grup variabel di alur YAML atau Klasik. Perubahan yang Anda buat pada grup variabel secara otomatis tersedia untuk semua definisi atau tahapan yang ditautkan ke grup variabel.

YAML

Jika Anda hanya memberi nama grup variabel dalam alur YAML, siapa pun yang dapat mendorong kode ke repositori Anda dapat mengekstrak konten rahasia dalam grup variabel. Oleh karena itu, untuk menggunakan grup variabel dengan alur YAML, Anda harus mengotorisasi alur untuk menggunakan grup. Anda dapat mengotorisasi alur untuk menggunakan grup variabel di antarmuka pengguna Azure Pipelines atau dengan menggunakan Azure DevOps CLI.

Otorisasi melalui UI Alur

Anda dapat mengotorisasi alur untuk menggunakan grup variabel Anda dengan menggunakan antarmuka pengguna Azure Pipelines.

1. Di proyek Azure DevOps Anda, pilih Pustaka Alur>dari menu sebelah kiri.
2. Pada halaman Pustaka , pilih grup variabel yang ingin Anda otorisasi.
3. Pada halaman grup variabel, pilih tab Izin alur.
4. Pada layar Izin alur, pilih + lalu pilih alur untuk diotorisasi. Atau, pilih ikon Tindakan lainnya, pilih Buka akses, dan pilih Buka akses lagi untuk mengonfirmasi.

Memilih alur mengotorisasi alur tersebut untuk menggunakan grup variabel. Untuk mengotorisasi alur lain, pilih ikon lagi + . Memilih Buka akses mengotorisasi semua alur proyek untuk menggunakan grup variabel. Akses terbuka mungkin merupakan opsi yang baik jika Anda tidak memiliki rahasia apa pun dalam grup.

Cara lain untuk mengotorisasi grup variabel adalah dengan memilih alur, pilih Edit, lalu antre build secara manual. Anda melihat kesalahan otorisasi sumber daya dan kemudian dapat secara eksplisit menambahkan alur sebagai pengguna yang berwenang dari grup variabel.

Otorisasi melalui Azure DevOps CLI

Di Azure DevOps Services, Anda dapat mengotorisasi grup variabel dengan menggunakan Azure DevOps CLI.

Untuk mengotorisasi semua alur proyek untuk menggunakan grup variabel, atur authorize parameter dalam perintah az pipelines variable-group create ke true. Akses terbuka ini mungkin merupakan opsi yang baik jika Anda tidak memiliki rahasia dalam grup.

Menautkan grup variabel ke alur

Setelah Anda mengotorisasi alur YAML untuk menggunakan grup variabel, Anda dapat menggunakan variabel dalam grup dalam alur.

Untuk menggunakan variabel dari grup variabel, tambahkan referensi ke nama grup dalam file alur YAML Anda.

variables:
- group: my-variable-group

Anda dapat mereferensikan beberapa grup variabel dalam alur yang sama. Jika beberapa grup variabel menyertakan variabel dengan nama yang sama, grup variabel terakhir yang menggunakan variabel dalam file mengatur nilai variabel. Untuk informasi selengkapnya tentang prioritas variabel, lihat Perluasan variabel.

Anda juga dapat mereferensikan grup variabel dalam templat. File templat variables.yml berikut mereferensikan grup my-variable-groupvariabel . Grup variabel mencakup variabel bernama myhello.

variables:
- group: my-variable-group

Alur YAML mereferensikan templat variables.yml , dan menggunakan variabel $(myhello) dari grup my-variable-groupvariabel .

stages:
- stage: MyStage
  variables:
  - template: variables.yml
  jobs:
  - job: Test
    steps:
    - script: echo $(myhello)

Menggunakan variabel dalam grup variabel tertaut

Anda mengakses nilai variabel dalam grup variabel tertaut dengan cara yang sama seperti Anda mengakses variabel yang Anda tentukan dalam alur. Misalnya, untuk mengakses nilai variabel bernama customer dalam grup variabel yang ditautkan ke alur, Anda dapat menggunakan $(customer) dalam parameter tugas atau skrip.

Jika Anda menggunakan variabel mandiri dan grup variabel dalam file alur Anda, gunakan name-value sintaks untuk variabel mandiri.

variables:
- group: my-variable-group
- name: my-standalone-variable
  value: 'my-standalone-variable-value'

Untuk mereferensikan variabel dalam grup variabel, Anda dapat menggunakan sintaks makro atau ekspresi runtime. Dalam contoh berikut, grup my-variable-group memiliki variabel bernama myhello.

Untuk menggunakan ekspresi runtime:

variables:
- group: my-variable-group
- name: my-passed-variable
  value: $[variables.myhello]
- script: echo $(my-passed-variable)

Untuk menggunakan sintaks makro:

variables:
- group: my-variable-group

steps:
- script: echo $(myhello)

Anda tidak dapat mengakses variabel rahasia, termasuk variabel terenkripsi dan variabel brankas kunci, langsung dalam skrip. Anda harus meneruskan variabel ini sebagai argumen ke tugas. Untuk informasi selengkapnya, lihat Variabel rahasia.

Klasik

Menggunakan grup variabel dalam alur Klasik

Alur klasik dapat menggunakan grup variabel tanpa otorisasi terpisah. Untuk menggunakan grup variabel:

1. Buka alur Klasik Anda.

2. >Pilih Variabel Grup variabel, lalu pilih Tautkan grup variabel.

   • Dalam alur build, Anda akan melihat daftar grup yang tersedia. Pilih grup variabel dan pilih Tautkan. Semua variabel dalam grup tersedia untuk digunakan dalam alur.

   • Dalam alur rilis, Anda juga melihat daftar dropdown tahapan dalam alur. Tautkan grup variabel ke alur itu sendiri, atau ke satu atau beberapa tahap tertentu dari alur rilis. Jika Anda menautkan ke satu atau beberapa tahap, variabel dari grup variabel dicakup ke tahap ini dan tidak dapat diakses di tahap lain rilis.

   

Saat Anda mengatur variabel dengan nama yang sama dalam beberapa cakupan, prioritas berikut digunakan, tertinggi terlebih dahulu:

1. Variabel ditetapkan pada waktu antrean
2. Variabel diatur dalam alur
3. Variabel diatur dalam grup variabel

Untuk informasi selengkapnya tentang prioritas variabel, lihat Perluasan variabel.

Catatan

Variabel dalam grup berbeda yang ditautkan ke alur dalam cakupan yang sama (misalnya, pekerjaan atau tahap) akan bertabrakan dan hasilnya mungkin tidak dapat diprediksi. Pastikan Anda menggunakan nama yang berbeda untuk variabel di semua grup variabel Anda.

Artikel terkait

• Tentukan variabel
• Menentukan variabel kustom
• Menggunakan variabel rahasia dan nonsecret dalam grup variabel
• Menggunakan rahasia Azure Key Vault di Azure Pipelines
• Menambahkan persetujuan dan pemeriksaan