Set-AzVMExtension

Memperbarui properti ekstensi atau menambahkan ekstensi ke komputer virtual.

Sintaks

Settings (Default)

Set-AzVMExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    -Publisher <String>
    -ExtensionType <String>
    -Name <String>
    [-Settings <Hashtable>]
    [-ProtectedSettings <Hashtable>]
    [-EnableAutomaticUpgrade <Boolean>]
    [-AsJob]
    [-TypeHandlerVersion <String>]
    [-Location <String>]
    [-DisableAutoUpgradeMinorVersion]
    [-ForceRerun <String>]
    [-NoWait]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SettingString

Set-AzVMExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    -Publisher <String>
    -ExtensionType <String>
    -Name <String>
    [-SettingString <String>]
    [-ProtectedSettingString <String>]
    [-EnableAutomaticUpgrade <Boolean>]
    [-AsJob]
    [-TypeHandlerVersion <String>]
    [-Location <String>]
    [-DisableAutoUpgradeMinorVersion]
    [-ForceRerun <String>]
    [-NoWait]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Deskripsi

Cmdlet Set-AzVMExtension memperbarui properti untuk Ekstensi Komputer Virtual yang ada atau menambahkan ekstensi ke komputer virtual.

Contoh

Contoh 1: Mengubah pengaturan dengan menggunakan tabel hash

$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings;

Dua perintah pertama menggunakan sintaks Windows PowerShell standar untuk membuat tabel hash, lalu menyimpan tabel hash tersebut dalam variabel $Settings dan $ProtectedSettings. Untuk informasi selengkapnya, ketik Get-Help about_Hash_Tables. Perintah kedua mencakup dua nilai yang dibuat sebelumnya dan disimpan dalam variabel. Perintah akhir memodifikasi ekstensi komputer virtual bernama VirtualMachine22 di ResourceGroup11 sesuai dengan konten $Settings dan $ProtectedSettings. Perintah menentukan informasi lain yang diperlukan yang menyertakan penerbit dan jenis ekstensi.

Contoh 2: Mengubah pengaturan dengan menggunakan string

$SettingsString = '{"fileUris":[],"commandToExecute":""}';
$ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ;

Dua perintah pertama membuat string yang berisi pengaturan, lalu menyimpannya dalam variabel $SettingsString dan $ProtectedSettingsString. Perintah akhir memodifikasi ekstensi komputer virtual bernama VirtualMachine22 di ResourceGroup11 sesuai dengan konten $SettingsString dan $ProtectedSettingsString. Perintah menentukan informasi lain yang diperlukan yang menyertakan penerbit dan jenis ekstensi.

Parameter

-AsJob

Jalankan cmdlet di latar belakang

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:Cf

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure.

Properti parameter

Jenis:IAzureContextContainer
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DisableAutoUpgradeMinorVersion

Menunjukkan bahwa cmdlet ini mencegah agen tamu Azure memperbarui ekstensi secara otomatis ke versi minor yang lebih baru. Secara default, cmdlet ini memungkinkan agen tamu memperbarui ekstensi.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-EnableAutomaticUpgrade

Menunjukkan apakah ekstensi harus ditingkatkan secara otomatis oleh platform jika ada versi ekstensi yang lebih baru yang tersedia.

Properti parameter

Jenis:

Nullable<T>[Boolean]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ExtensionType

Menentukan jenis ekstensi.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Type

Kumpulan parameter

(All)
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ForceRerun

Menunjukkan bahwa cmdlet ini memaksa pengintaian ulang konfigurasi ekstensi yang sama pada komputer virtual tanpa menghapus instalan dan menginstal ulang ekstensi. Nilainya dapat berupa string apa pun yang berbeda dari nilai saat ini. Jika forceUpdateTag tidak diubah, pembaruan pada pengaturan publik atau terproteksi masih diterapkan oleh handler.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Location

Menentukan lokasi komputer virtual.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Name

Menentukan nama ekstensi.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:ExtensionName

Kumpulan parameter

(All)
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-NoWait

Memulai operasi dan segera kembali, sebelum operasi selesai. Untuk menentukan apakah operasi telah berhasil diselesaikan, gunakan beberapa mekanisme lain.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ProtectedSettings

Menentukan konfigurasi privat untuk ekstensi, sebagai tabel hash. Cmdlet ini mengenkripsi konfigurasi privat.

Properti parameter

Jenis:Hashtable
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Settings
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ProtectedSettingString

Menentukan konfigurasi privat untuk ekstensi, sebagai string. Cmdlet ini mengenkripsi konfigurasi privat.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

SettingString
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Publisher

Menentukan nama penerbit ekstensi. Penerbit memberikan nama saat penerbit mendaftarkan ekstensi.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ResourceGroupName

Menentukan nama grup sumber daya komputer virtual.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Settings

Menentukan konfigurasi publik untuk ekstensi, sebagai tabel hash. Cmdlet ini tidak mengenkripsi konfigurasi publik.

Properti parameter

Jenis:Hashtable
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Settings
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-SettingString

Menentukan konfigurasi publik untuk ekstensi, sebagai string. Cmdlet ini tidak mengenkripsi konfigurasi publik.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

SettingString
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-TypeHandlerVersion

Menentukan versi ekstensi yang akan digunakan untuk komputer virtual ini.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:HandlerVersion, Versi

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-VMName

Menentukan nama komputer virtual. Cmdlet ini memodifikasi ekstensi untuk komputer virtual yang ditentukan parameter ini.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:ResourceName

Kumpulan parameter

(All)
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:wi

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

String

Hashtable

SwitchParameter

Output

PSAzureOperationResponse