az automation runbook

  • Eksperimental
  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi otomatisasi untuk Azure CLI (versi 2.55.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah runbook otomatisasi az. Pelajari lebih lanjut tentang ekstensi.

Grup perintah ini bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Automation Runbook.

Perintah

Nama Deskripsi Jenis Status
az automation runbook create

Buat runbook yang diidentifikasi dengan nama runbook.

 Ekstensi Eksperimental
az automation runbook delete

Hapus runbook menurut nama.

 Ekstensi Eksperimental
az automation runbook list

Ambil daftar runbook.

 Ekstensi Eksperimental
az automation runbook publish

Terbitkan draf runbook.

 Ekstensi Eksperimental
az automation runbook replace-content

Ganti konten runbook.

 Ekstensi Eksperimental
az automation runbook revert-to-published

Kembalikan konten runbook ke status terakhir yang diketahui diterbitkan.

 Ekstensi Eksperimental
az automation runbook show

Ambil runbook yang diidentifikasi dengan nama runbook.

 Ekstensi Eksperimental
az automation runbook start

Mulai runbook.

 Ekstensi Eksperimental
az automation runbook update

Perbarui runbook yang diidentifikasi dengan nama runbook.

 Ekstensi Eksperimental
az automation runbook wait

Tempatkan CLI dalam status tunggu hingga kondisi runbook otomatisasi terpenuhi.

 Ekstensi Eksperimental

az automation runbook create

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Buat runbook yang diidentifikasi dengan nama runbook.

az automation runbook create --automation-account-name
                             --name
                             --resource-group
                             --type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script}
                             [--description]
                             [--location]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--tags]

Contoh

Membuat runbook

az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --type "PowerShell" --location "East US 2"

Parameter yang Diperlukan

--automation-account-name

Nama akun automasi.

--name --runbook-name -n

Nama runbook.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--type

Jenis runbook.

nilai yang diterima: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

Parameter Opsional

--description

Deskripsi runbook.

--location -l

Lokasi. Nilai dari: az account list-locations. Anda dapat mengonfigurasi lokasi default menggunakan az configure --defaults location=<location>.

--log-activity-trace

Opsi pelacakan tingkat aktivitas runbook.

--log-progress

Opsi log kemajuan dari runbook.

nilai yang diterima: false, true
--log-verbose

Opsi log Verbose dari runbook.

nilai yang diterima: false, true
--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook delete

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Hapus runbook menurut nama.

az automation runbook delete [--automation-account-name]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--yes]

Contoh

Menghapus runbook

az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Parameter Opsional

--automation-account-name

Nama akun automasi.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name --runbook-name -n

Nama runbook.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--yes -y

Jangan meminta konfirmasi.

nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook list

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Ambil daftar runbook.

az automation runbook list --automation-account-name
                           --resource-group

Contoh

Mencantumkan runbook menurut akun otomatisasi

az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"

Parameter yang Diperlukan

--automation-account-name

Nama akun automasi.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook publish

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Terbitkan draf runbook.

az automation runbook publish [--automation-account-name]
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]

Contoh

Menerbitkan draf runbook

az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook"

Parameter Opsional

--automation-account-name

Nama akun automasi.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name --runbook-name -n

Parameter yang disediakan untuk operasi terbitkan runbook.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook replace-content

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Ganti konten runbook.

az automation runbook replace-content --content
                                      [--automation-account-name]
                                      [--ids]
                                      [--name]
                                      [--no-wait]
                                      [--resource-group]
                                      [--subscription]

Contoh

Mengganti konten runbook

az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook" --content @/path/to/script

Parameter yang Diperlukan

--content

Konten runbook.

Parameter Opsional

--automation-account-name

Nama akun automasi.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name --runbook-name -n

Nama runbook.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook revert-to-published

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Kembalikan konten runbook ke status terakhir yang diketahui diterbitkan.

az automation runbook revert-to-published [--automation-account-name]
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Contoh

Mengganti konten runbook

az automation runbook revert-to-published --automation-account-name "myAutomationAccount"                --resource-group "rg" --name "myRunbook"

Parameter Opsional

--automation-account-name

Nama akun automasi.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name --runbook-name -n

Nama runbook.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook show

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Ambil runbook yang diidentifikasi dengan nama runbook.

az automation runbook show [--automation-account-name]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Contoh

Mendapatkan runbook

az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Parameter Opsional

--automation-account-name

Nama akun automasi.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name --runbook-name -n

Nama runbook.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook start

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Mulai runbook.

az automation runbook start [--automation-account-name]
                            [--ids]
                            [--name]
                            [--parameters]
                            [--resource-group]
                            [--run-on]
                            [--subscription]

Contoh

Memulai runbook

az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Parameter Opsional

--automation-account-name

Nama akun automasi.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name --runbook-name -n

Nama runbook.

--parameters

Parameter pekerjaan. Mengharapkan nilai: KEY1=VALUE1 KEY2=VALUE2 ...

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--run-on

RunOn yang menentukan nama grup tempat pekerjaan akan dijalankan.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook update

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Perbarui runbook yang diidentifikasi dengan nama runbook.

az automation runbook update [--automation-account-name]
                             [--description]
                             [--ids]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--tags]

Contoh

Memperbarui runbook

az automation runbook update --automation-account-name "myAutomationAccount" --description                "Runbook Description" --log-activity-trace 1 --log-progress true --log-verbose false                --resource-group "rg" --runbook-name "myRunbook"

Parameter Opsional

--automation-account-name

Nama akun automasi.

--description

Deskripsi runbook.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--log-activity-trace

Opsi pelacakan tingkat aktivitas runbook.

--log-progress

Opsi log kemajuan dari runbook.

nilai yang diterima: false, true
--log-verbose

Opsi log Verbose dari runbook.

nilai yang diterima: false, true
--name --runbook-name -n

Nama runbook.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az automation runbook wait

Eksperimental

Grup perintah 'runbook otomatisasi' bersifat eksperimental dan sedang dikembangkan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus

Tempatkan CLI dalam status tunggu hingga kondisi runbook otomatisasi terpenuhi.

az automation runbook wait [--automation-account-name]
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

Contoh

Jeda menjalankan baris skrip CLI berikutnya hingga runbook otomatisasi berhasil dibuat.

az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --created

Parameter Opsional

--automation-account-name

Nama akun automasi.

--created

Tunggu hingga dibuat dengan 'provisioningState' di 'Berhasil'.

nilai default: False
--custom

Tunggu hingga kondisi memenuhi kueri JMESPath kustom. Misalnya provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Tunggu hingga dihapus.

nilai default: False
--exists

Tunggu hingga sumber daya ada.

nilai default: False
--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--interval

Interval polling dalam hitungan detik.

nilai default: 30
--name --runbook-name -n

Nama runbook.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--timeout

Tunggu maksimum dalam detik.

nilai default: 3600
--updated

Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.

nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.