Azure Sphere CLI
Penting
Ini adalah dokumentasi Azure Sphere (Warisan). Azure Sphere (Warisan) dihentikan pada 27 September 2027, dan pengguna harus bermigrasi ke Azure Sphere (Terintegrasi) saat ini. Gunakan pemilih Versi yang terletak di atas TOC untuk melihat dokumentasi Azure Sphere (Terintegrasi).
Azure Sphere SDK menyediakan antarmuka baris perintah (CLI) Azure Sphere yang tersedia di PowerShell, Windows Command Prompt, atau shell perintah Linux. Azure Sphere CLI adalah sekumpulan perintah yang digunakan untuk membuat dan mengelola sumber daya Azure Sphere.
Azure Sphere CLI diinstal bersama CLI klasik Azure Sphere yang dihentikan di Windows dan Linux, sehingga Anda memiliki akses ke salah satu antarmuka. Untuk menggunakan Azure Sphere CLI:
- Di Windows, gunakan PowerShell atau Prompt Perintah Windows standar.
- Di Linux, gunakan shell perintah apa pun.
Menjalankan Azure Sphere CLI
Sekarang Anda dapat menjalankan Azure Sphere CLI dengan azsphere perintah dari Windows Command Prompt atau PowerShell. Kami merekomendasikan PowerShell karena menawarkan fitur penyelesaian tab yang tidak tersedia dari Prompt Perintah Windows.
Di Linux, Anda dapat menjalankan Azure Sphere CLI dari antarmuka baris perintah (CLI) apa pun. Selama penginstalan, pemberitahuan ditampilkan yang memungkinkan Anda mengatur Azure Sphere CLI atau CLI klasik Azure Sphere sebagai versi CLI default pilihan.
Ketik Yes untuk memilih Azure Sphere CLI atau ketik No untuk menggunakan CLI klasik Azure Sphere. Lihat Menginstal Azure Sphere SDK untuk informasi selengkapnya.
Catatan
Formulir singkat untuk perintah tidak didukung dalam versi Azure Sphere CLI. Kami menyarankan agar Anda menggunakan fitur penyelesaian tab untuk melihat daftar perintah yang tersedia. Di Windows, pintasan Prompt Perintah Pengembang Klasik Azure Sphere yang dihentikan hanya dapat digunakan dengan CLI klasik Azure Sphere.
Fitur input CLI
Bagian ini menjelaskan fitur input yang tersedia di Azure Sphere CLI:
Perintah
Semua perintah di Azure Sphere CLI dimulai dengan azsphere. Contohnya:
azsphere login
---------------------
Name
=====================
bob@contoso.com
---------------------
Menemukan perintah
Perintah dalam CLI diatur dalam grup. Anda dapat melihat informasi bantuan lengkap untuk perintah dan parameter yang tersedia dengan menggunakan --help di CLI klasik Azure Sphere dan Azure Sphere CLI.
Anda bisa mendapatkan daftar lengkap perintah dengan menjalankan perintah azsphere --help.
Contohnya:
- Untuk penggunaan CLI klasik Azure Sphere,
azsphere --helpatauazsphere -? - Untuk penggunaan Azure Sphere CLI,
azsphere --helpatauazsphere -h
Parameter
Nama parameter didahului oleh tanda hubung ganda (--), yang menandakan bahwa kata yang mengikuti tanda hubung adalah parameter. Gunakan spasi untuk memisahkan nama dan nilai parameter. Parameter yang merupakan kata gabungan dipisahkan dengan tanda hubung (-) di CLI baru.
Misalnya: --component-id atau --application-update
Identifikasi objek yang disederhanakan
Di Azure Sphere CLI, satu parameter digunakan untuk mengidentifikasi setiap jenis objek. Ini berarti Anda dapat memberikan ID, nama, IP, atau lokasi yang berlaku untuk parameter tersebut.
Misalnya, Anda dapat menggunakan ID penyewa atau nama penyewa dalam perintah berikut:
azsphere device list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
or
azsphere device list --tenant MyTenant
Ini telah diimplementasikan untuk --deviceparameter , --tenant, --product, dan --device-group .
Contohnya:
azsphere device-group update --device-group CoffeeMaker/Development
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------
Id TenantId OsFeedType ProductId Name Description UpdatePolicy AllowCrashDumpsCollection
===============================================================================================================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 6f52bead-700d-4289-bdc2-2f11f774270e Marketing Marketing device group Accept all updates from the Azure Sphere Security Service. False
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------
Beberapa nilai
Beberapa perintah memungkinkan beberapa nilai untuk satu parameter, dalam hal ini Anda dapat menyediakan parameter dengan setiap nilai, atau parameter tunggal diikuti dengan daftar nilai yang dipisahkan oleh spasi. Misalnya, dua perintah berikut setara:
azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 --executables filepath-2
azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2
Parameter yang diperlukan dan opsional
Saat Anda menjalankan azsphere <command> <sub-command> --help daftar parameter yang berlaku untuk perintah tersebut ditampilkan. Pengaturan [Wajib] menunjukkan apakah parameter wajib untuk berhasil menjalankan perintah. Semua parameter bersifat opsional.
Jika parameter yang diperlukan hilang, Anda akan dimintai nilai untuk parameter .
Contohnya:
azsphere role delete --help
Command
azsphere role delete : Deletes a role from a user in the current Azure Sphere tenant.
Arguments
--role -r [Required] : Role to be deleted. Values from: azsphere role show-types.
--user -u [Required] : The user from whom the role is being deleted. Specify user e-mail.
Values from: azsphere role list.
Tenant Selection Arguments
--tenant -t : The tenant to perform this operation in. Overrides the default selected
tenant. Specify tenant ID or tenant name. Values from: azsphere tenant
list.
Global Arguments
--debug : Increase logging verbosity to show all debug logs.
--help -h : Show this help message and exit.
--only-show-errors : Only show errors, suppressing warnings.
--output -o : Output format. Allowed values: json, jsonc, none, table, tsv, yaml,
yamlc. Default: table.
--query : JMESPath query string. See http://jmespath.org/ for more information and
examples.
--verbose : Increase logging verbosity. Use --debug for full debug logs.
Jalur input dan output
Di Azure Sphere CLI, nama parameter yang digunakan untuk menentukan jalur dan nama file telah diperbarui agar relevan dengan konteks perintah.
Contohnya:
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
Di sini, --package-directory menentukan direktori input untuk paket dan --destination parameter menentukan jalur dan nama file untuk paket gambar yang dihasilkan.
Penyelesaian tab
Penyelesaian tab menyediakan bantuan dalam menyelesaikan entri perintah secara otomatis di antarmuka baris perintah. Di penyelesaian tab Azure Sphere CLI didukung untuk grup, perintah, nama parameter, dan nilai parameter. Ketik beberapa karakter perintah lalu tekan TAB untuk memilih teks penyelesaian yang diinginkan. Jika beberapa item dimulai dengan teks yang awalnya Anda ketik, lanjutkan menekan TAB hingga item yang Anda inginkan muncul.
Di Windows, PowerShell 7.1 menawarkan fitur penyelesaian tab yang tidak tersedia dari Prompt Perintah Windows.
Untuk mengaktifkan penyelesaian tab di Windows PowerShell, jalankan Import-Module -name AzsphereCli.
Perintah ini mengaktifkan penyelesaian tab hanya untuk sesi. Anda dapat menambahkan skrip ke profil PowerShell untuk menyesuaikan lingkungan Anda dan mengaktifkan penyelesaian tab untuk setiap sesi PowerShell yang Anda mulai.
Di Linux, Azure Sphere CLI mendukung fitur penyelesaian tab untuk perintah di bawah shell Bash.
Selain itu, pelengkapan otomatis membantu Anda menemukan nilai perintah, parameter, dan parameter yang tersedia untuk digunakan. Ini tersedia dengan menggunakan CTRL+Space di Windows PowerShell atau tekan TAB dua kali di shell Linux Bash.
Misalnya, ketik perintah pembaruan produk azsphere dan gunakan pelengkapan otomatis untuk melihat daftar parameter yang tersedia.
Demikian pula, ketik azsphere product update --product dan gunakan autocompletion untuk melihat daftar produk yang tersedia di penyewa Anda.
Mode interaktif (pratinjau)
Penting
Fitur ini masih dalam pratinjau. Ini dapat diubah atau dihapus dalam rilis mendatang.
CLI baru menawarkan mode interaktif yang secara otomatis menampilkan informasi bantuan dan memudahkan untuk memilih perintah, sub-perintah, parameter, dan nilai parameter. Masukkan mode interaktif dengan perintah interaktif azsphere. Perintah berubah menjadi azsphere>> untuk menunjukkan bahwa Anda sekarang menjalankan perintah di shell interaktif.
Untuk informasi selengkapnya, lihat Mode interaktif Azure Sphere CLI.
Fitur output CLI
Bagian ini menjelaskan fitur output yang tersedia di Azure Sphere CLI:
Bagian berikut menjelaskan fitur output yang tersedia di CLI baru:
Format output yang didukung
Format output yang tersedia dalam CLI baru adalah json, jsonc (JSON berwarna), tsv (Nilai yang Dipisahkan Tab), table (tabel ASCII yang dapat dibaca manusia), dan yaml. Secara default, CLI menghasilkan table. Untuk mempelajari selengkapnya tentang format output yang tersedia, lihat Format output yang didukung untuk Azure Sphere CLI.
Pengalihan dan penomoran halaman
Azure Sphere CLI tidak mendukung penomoran halaman interaktif. Namun, Anda dapat mengalihkan output standar perintah ke file. Dalam contoh berikut, untuk shell Windows Command Prompt, Windows PowerShell, dan Linux Bash, output standar dikirim ke output.txt dan kesalahan standar dikirim ke logs.txt.
azsphere device list --verbose > output.txt 2> logs.txt
Anda juga dapat mem-paginate output di layar dengan mempipa ke alat penomoran halaman yang ada.
Contohnya:
- Di PowerShell (Windows):
azsphere device list | Out-Host –Paging - Pada prompt perintah (Windows):
azsphere device list | more - Di shell Bash (Linux):
azsphere device list | less
Catatan
Operasi ini berpotensi lambat tergantung pada berapa banyak data yang dikembalikan.
Untuk informasi selengkapnya tentang penomoran halaman untuk CLI klasik Azure Azure Sphere, lihat Penomoran halaman dan pengalihan hasil.
Output perintah CLI kueri
Azure Sphere CLI menggunakan --query argumen untuk menjalankan kueri JMESPath pada hasil perintah. JMESPath adalah bahasa kueri untuk JSON, memberi Anda kemampuan untuk memilih dan mengubah data dari output CLI. Kueri dijalankan pada output JSON sebelum pemformatan tampilan apa pun.
Argumen --query didukung oleh semua perintah di Azure Sphere CLI. Lihat tutorial JMESPath dan Output perintah Query Azure CLI untuk informasi dan contoh selengkapnya.
Kompatibilitas mundur
CLI mendukung kompatibilitas mundur. Dalam setiap rilis, kami bertujuan untuk mempertahankan kompatibilitas mundur untuk input (nama perintah, nama parameter, nilai parameter) dan outputnya di JSON dan YAML. Jika kompatibilitas tersebut tidak dimungkinkan, kami akan memberikan pemberitahuan setidaknya 6 bulan sebelum membuat perubahan. Untuk informasi selengkapnya, lihat Perubahan penting (fitur penghentian) di Azure Sphere CLI.
Kode keluar
Perintah yang berhasil mengembalikan nol. Nilai non-nol apa pun dapat ditafsirkan sebagai kode kesalahan. Setelah berhasil, output JSON dan YAML memiliki jaminan kontraktual yang kompatibel dengan mundur.
Memberikan tanggapan
Jika Anda menemukan bug di Azure Sphere, ajukan masalah di GitHub. Untuk memberikan umpan balik dari baris perintah, gunakan perintah umpan balik.
Menggunakan Azure Sphere CLI secara efektif
Azure Sphere CLI dapat digunakan dari jendela Bash, PowerShell, atau Prompt Perintah. Berikut adalah beberapa tips untuk menggunakan CLI:
- Menggunakan tanda kutip dalam nilai: Jika Anda memberikan parameter nilai yang menyertakan spasi, sertakan dalam tanda kutip. Di Bash atau PowerShell, kutipan tunggal dan ganda ditafsirkan. Dalam Windows Command Prompt, hanya tanda kutip ganda yang ditafsirkan. Kutipan tunggal ditafsirkan sebagai bagian dari nilai. Contohnya,
azsphere product create --name "My Fridge Product". Untuk informasi selengkapnya, lihat Tanda kutip dan karakter escape. - Banyak perintah Azure Sphere menunjukkan informasi di konsol dalam format default
table. Contohnya,azsphere product device-group list --product DW100. Terkadang informasi yang ditampilkan tidak sesuai dengan konsol dengan benar. Ini dapat menyebabkan masalah jika Anda ingin menyalin dan menempelkan informasi. Sebaiknya coba opsi berikut:- Mengubah ukuran konsol dan menjalankan perintah lagi.
- Gunakan output JSON untuk output ringkas dan tujuan pembuatan skrip. Contohnya,
azsphere product device-group list --product DW100 --output json. - Gunakan penyelesaian tab di Shell Windows PowerShell atau Bash untuk menyelesaikan entri perintah secara otomatis.
- Gunakan mode interaktif yang menyediakan lingkungan interaktif untuk menampilkan informasi secara otomatis dan memudahkan untuk memilih perintah dan sub-perintah. Masukkan mode interaktif dengan perintah interaktif azsphere. Perintah berubah menjadi azsphere>> untuk menunjukkan bahwa Anda sekarang menjalankan perintah di shell interaktif.