Mengaktifkan ekstensi VM Azure menggunakan Azure CLI

Artikel
03/30/2023

Artikel ini menunjukkan cara menyebarkan, meningkatkan, memperbarui, dan menghapus instalan ekstensi mesin virtual, yang didukung oleh server dengan dukungan Azure Arc, ke mesin hibrid Linux atau Windows menggunakan Azure CLI.

Catatan

Server yang diaktifkan Azure Arc tidak mendukung penyebaran dan pengelolaan ekstensi VM ke komputer virtual Azure. Untuk Azure VM, lihat artikel Gambaran umum ekstensi VM berikut.

Prasyarat

Gunakan lingkungan Bash di Azure Cloud Shell. Untuk informasi selengkapnya, lihat Mulai Cepat untuk Bash di Azure Cloud Shell.
Jika Anda lebih suka menjalankan perintah referensi CLI secara lokal, instal Azure CLI. Jika Anda menjalankan Windows atau macOS, pertimbangkan untuk menjalankan Azure CLI dalam kontainer Docker. Untuk informasi lebih lanjut, lihat Cara menjalankan Azure CLI di kontainer Docker.
- Jika Anda menggunakan instalasi lokal, masuk ke Azure CLI dengan menggunakan perintah login az. Untuk menyelesaikan proses autentikasi, ikuti langkah-langkah yang ditampilkan di terminal Anda. Untuk opsi masuk lainnya, lihat Masuk dengan Azure CLI.
- Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan ekstensi dengan Azure CLI.
- Jalankan versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan peningkatan az.

Memasang ekstensi Azure CLI

Perintah ConnectedMachine tidak dikirimkan sebagai bagian dari Azure CLI. Sebelum menggunakan Azure CLI untuk mengelola ekstensi mesin virtual di server hibrid yang dikelola oleh server yang didukung Azure Arc, Anda perlu memuat ekstensi ConnectedMachine. Operasi pengelolaan ini dapat dilakukan dari stasiun kerja Anda, Anda tidak perlu menjalankannya di server yang didukung Azure Arc.

Jalankan perintah berikut untuk mendapatkannya:

az extension add --name connectedmachine

Mengaktifkan ekstensi

Untuk mengaktifkan ekstensi komputer virtual di server yang diaktifkan Azure Arc, gunakan pembuatan ekstensi az connectedmachine dengan parameter --machine-name, --extension-name, --location, --type, settings, dan --publisher.

Contoh berikut mengaktifkan ekstensi komputer virtual Log Analytics pada server Azure Arc yang diaktifkan:

az connectedmachine extension create --machine-name "myMachineName" --name "OmsAgentForLinux or MicrosoftMonitoringAgent" --location "regionName" --settings '{\"workspaceId\":\"myWorkspaceId\"}' --protected-settings '{\"workspaceKey\":\"myWorkspaceKey\"}' --resource-group "myResourceGroup" --type-handler-version "1.13" --type "OmsAgentForLinux or MicrosoftMonitoringAgent" --publisher "Microsoft.EnterpriseCloud.Monitoring"

Contoh berikut mengaktifkan Ekstensi Skrip Kustom pada server Azure Arc yang diaktifkan:

az connectedmachine extension create --machine-name "myMachineName" --name "CustomScriptExtension" --location "regionName" --type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version "1.10" --resource-group "myResourceGroup"

Contoh berikut mengaktifkan ekstensi komputer virtual Key Vault pada server Azure Arc yang diaktifkan:

az connectedmachine extension create --resource-group "resourceGroupName" --machine-name "myMachineName" --location "regionName" --publisher "Microsoft.Azure.KeyVault" --type "KeyVaultForLinux or KeyVaultForWindows" --name "KeyVaultForLinux or KeyVaultForWindows" --settings '{"secretsManagementSettings": { "pollingIntervalInS": "60", "observedCertificates": ["observedCert1"] }, "authenticationSettings": { "msiEndpoint": "http://localhost:40342/metadata/identity" }}'

Contoh berikut mengaktifkan ekstensi Microsoft Antimalware di server Windows yang didukung Azure Arc:

az connectedmachine extension create --resource-group "resourceGroupName" --machine-name "myMachineName" --location "regionName" --publisher "Microsoft.Azure.Security" --type "IaaSAntimalware" --name "IaaSAntimalware" --settings '"{\"AntimalwareEnabled\": \"true\"}"'

Contoh berikut mengaktifkan ekstensi Datadog di server Windows dengan dukungan Azure Arc:

az connectedmachine extension create --resource-group "resourceGroupName" --machine-name "myMachineName" --location "regionName" --publisher "Datadog.Agent" --type "DatadogWindowsAgent" --settings '{"site": "us3.datadoghq.com"}' --protected-settings '{"api_key": "YourDatadogAPIKey" }'

Buat daftar ekstensi yang dipasang

Untuk mendapatkan daftar ekstensi komputer virtual di server Azure Arc yang diaktifkan, gunakan daftar ekstensi az connectedmachine dengan parameter --machine-name dan --resource-group.

Contoh:

az connectedmachine extension list --machine-name "myMachineName" --resource-group "myResourceGroup"

Secara default, output dari perintah Azure CLI ada di JavaScript Object Notation (JSON). Untuk mengubah output default ke daftar atau tabel, misalnya, gunakan az config set core.output=table. Anda juga dapat menambahkan --output ke perintah apa pun untuk satu kali perubahan dalam format output.

Contoh berikut menunjukkan sebagian output JSON dari perintah az connectedmachine extension -list:

[
  {
    "autoUpgradingMinorVersion": "false",
    "forceUpdateTag": null,
    "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridCompute/machines/SVR01/extensions/DependencyAgentWindows",
    "location": "regionName",
    "name": "DependencyAgentWindows",
    "namePropertiesInstanceViewName": "DependencyAgentWindows",

Perbarui konfigurasi ekstensi

Beberapa ekstensi mesin virtual memerlukan pengaturan konfigurasi untuk menginstalnya di server dengan dukungan Arc, seperti Ekstensi Skrip Kustom dan ekstensi mesin virtual agen Analitik Log. Untuk meningkatkan konfigurasi ekstensi, gunakan az connectedmachine extension update.

Contoh berikut menunjukkan cara mengonfigurasi Ekstensi Skrip Kustom:

az connectedmachine extension update --name "CustomScriptExtension" --type "CustomScriptExtension" --publisher "Microsoft.HybridCompute" --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version "1.10" --machine-name "myMachine" --resource-group "myResourceGroup"

Memutakhirkan ekstensi

Saat versi baru dari ekstensi mesin virtual yang didukung dirilis, Anda dapat meningkatkannya ke rilis terbaru tersebut. Untuk meningkatkan ekstensi mesin virtual, gunakan az connectedmachine upgrade-extension dengan parameter --machine-name, --resource-group, dan --extension-targets.

Untuk parameter --extension-targets, Anda perlu menentukan ekstensi dan versi terbaru yang tersedia. Untuk mengetahui versi terbaru yang tersedia, Anda dapat memperoleh informasi ini dari halaman Ekstensi untuk server dengan dukungan Arc yang dipilih di portal Microsoft Azure, atau dengan menjalankan az vm extension image list. Anda dapat menentukan beberapa ekstensi dalam satu permintaan peningkatan dengan menyediakan daftar ekstensi yang dipisahkan koma, yang ditentukan oleh penerbit dan jenisnya (dipisahkan oleh periode) dan versi target untuk setiap ekstensi, seperti yang ditunjukkan pada contoh di bawah ini.

Guna meningkatkan ekstensi agen Analitik Log untuk Windows yang memiliki versi yang lebih baru, jalankan perintah berikut:

az connectedmachine upgrade-extension --machine-name "myMachineName" --resource-group "myResourceGroup" --extension-targets '{\"Microsoft.EnterpriseCloud.Monitoring.MicrosoftMonitoringAgent\":{\"targetVersion\":\"1.0.18053.0\"}}'

Anda dapat meninjau versi ekstensi mesin virtual yang diinstal kapan saja dengan menjalankan perintah az connectedmachine extension list. Nilai properti typeHandlerVersion mewakili versi ekstensi.

Menghapus ekstensi

Untuk menghapus ekstensi mesin virtual yang diinstal di server dengan dukungan Azure Arc, gunakan az connectedmachine extension delete dengan parameter --extension-name, --machine-name, dan --resource-group.

Misalnya, untuk menghapus ekstensi VM Log Analytics untuk Linux, jalankan perintah berikut:

az connectedmachine extension delete --machine-name "myMachineName" --name "OmsAgentForLinux" --resource-group "myResourceGroup"

Langkah berikutnya

Anda dapat menyebarkan, mengelola, dan menghapus ekstensi VM menggunakan Azure PowerShell, dari portal Azure, atau templat Azure Resource Manager.
Informasi pemecahan masalah dapat ditemukan di Panduan ekstensi VM pemecahan masalah.
Tinjau artikel Gambaran Umum ekstensi VM Azure CLI untuk informasi selengkapnya tentang perintah.