Add-AzureRmVmssExtension
VMSS に拡張機能を追加します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Add-AzureRmVmssExtension
[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
[[-Name] <String>]
[[-Publisher] <String>]
[[-Type] <String>]
[[-TypeHandlerVersion] <String>]
[[-AutoUpgradeMinorVersion] <Boolean>]
[[-Setting] <Object>]
[[-ProtectedSetting] <Object>]
[-ForceUpdateTag <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Add-AzureRmVmssExtension コマンドレットは、仮想マシン スケール セット (VMSS) に拡張機能を追加します。
例
例 1: VMSS に拡張機能を追加する
PS C:\> Add-AzureRmVmssExtension -VirtualMachineScaleSet $VMSS -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $Trueこのコマンドは、VMSS に拡張機能を追加します。
例 2: 設定と保護された設定を使用して VMSS に拡張機能を追加する
PS C:\> $Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
PS C:\> $ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
PS C:\> Add-AzureRmVmssExtension -VirtualMachineScaleSet $vmss -Name $vmssExtensionName -Publisher $vmssPublisher `
-Type $vmssExtensionType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True `
-Setting $Settings -ProtectedSetting $ProtectedSettingsこのコマンドは、BLOB ストレージ上のサンプル bash スクリプトを使用して VMSS に拡張機能を追加し、保護された設定の設定とセキュリティ アクセスで BLOB ストレージと実行可能コマンドの URL を指定します。
パラメーター
-AutoUpgradeMinorVersion
拡張機能のバージョンを新しいマイナー バージョンに自動的に更新するかどうかを示します。
| Type: | Nullable<T>[Boolean] |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceUpdateTag
値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
このコマンドレットが追加する拡張機能の名前を指定します。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProtectedSetting
拡張機能のプライベート構成を文字列として指定します。 このコマンドレットは、プライベート構成を暗号化します。
| Type: | Object |
| Position: | 7 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Publisher
拡張機能の発行元の名前を指定します。 パブリッシャーは、パブリッシャーが拡張機能を登録するときに名前を提供します。 これにより、Get-AzureRmVMImagePublisher コマンドレットを使用してパブリッシャーを取得できます。
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Setting
拡張機能のパブリック構成を文字列として指定します。 このコマンドレットでは、パブリック構成は暗号化されません。
| Type: | Object |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Type
拡張の種類を指定します。 Get-AzureRmVMExtensionImageType コマンドレットを使用して、拡張機能の種類を取得できます。
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TypeHandlerVersion
この仮想マシンに使用する拡張機能のバージョンを指定します。 Get-AzureRmVMExtensionImage コマンドレットを使用して、拡張機能のバージョンを取得できます。
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualMachineScaleSet
VMSS オブジェクトを指定します。 New-AzureRmVmssConfig を使用してオブジェクトを作成できます。
| Type: | PSVirtualMachineScaleSet |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]