< Back
Add-AzureRmVmssExtension
Post
NAME Add-AzureRmVmssExtension
SYNOPSIS
Adds an extension to the VMSS.
SYNTAX
Add-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] [[-Publisher] <String>] [[-Type] <String>]
[[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>] [-DefaultProfile
<IAzureContextContainer>] [-ForceUpdateTag <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmVmssExtension cmdlet adds an extension to the Virtual Machine Scale Set (VMSS).
PARAMETERS
-AutoUpgradeMinorVersion <Boolean>
Indicates whether the extension version should be automatically updated to a newer minor version.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ForceUpdateTag <String>
If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension
configuration has not changed.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the extension that this cmdlet adds.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProtectedSetting <Object>
Specifies private configuration for the extension, as a string. This cmdlet encrypts the private configuration.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Publisher <String>
Specifies the name of the extension publisher. The publisher provides a name when the publisher registers an extension. This can use the
Get-AzureRmVMImagePublisher (./Get-AzureRmVMImagePublisher.md)cmdlet to get the publisher.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Setting <Object>
Specifies the public configuration, as a string, for the extension. This cmdlet does not encrypt public configuration.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <String>
Specifies the extension type. You can use the Get-AzureRmVMExtensionImageType (./Get-AzureRmVMExtensionImageType.md)cmdlet to get the
extension type.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the extension to use for this virtual machine. You can use the Get-AzureRmVMExtensionImage
(./Get-AzureRmVMExtensionImage.md)cmdlet to get the version of the extension.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualMachineScaleSet <PSVirtualMachineScaleSet>
Specify the VMSS object. You can use the New-AzureRmVmssConfig (./New-AzureRmVmssConfig.md)to create the object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
VirtualMachineScaleSet
Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline
OUTPUTS
This cmdlet does not generate any output.
NOTES
Example 1: Add an extension to the VMSS
PS C:\\> Add-AzureRmVmssExtension -VirtualMachineScaleSet $VMSS -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer
-AutoUpgradeMinorVersion $True
This command adds an extension to the VMMS.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sextension
Remove-AzureRmVmssExtension
Get-AzureRmVMImagePublisher
Get-AzureRmVMExtensionImageType
Get-AzureRmVMExtensionImage
New-AzureRmVmssConfig
SYNOPSIS
Adds an extension to the VMSS.
SYNTAX
Add-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] [[-Publisher] <String>] [[-Type] <String>]
[[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>] [-DefaultProfile
<IAzureContextContainer>] [-ForceUpdateTag <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmVmssExtension cmdlet adds an extension to the Virtual Machine Scale Set (VMSS).
PARAMETERS
-AutoUpgradeMinorVersion <Boolean>
Indicates whether the extension version should be automatically updated to a newer minor version.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ForceUpdateTag <String>
If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension
configuration has not changed.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the extension that this cmdlet adds.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProtectedSetting <Object>
Specifies private configuration for the extension, as a string. This cmdlet encrypts the private configuration.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Publisher <String>
Specifies the name of the extension publisher. The publisher provides a name when the publisher registers an extension. This can use the
Get-AzureRmVMImagePublisher (./Get-AzureRmVMImagePublisher.md)cmdlet to get the publisher.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Setting <Object>
Specifies the public configuration, as a string, for the extension. This cmdlet does not encrypt public configuration.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <String>
Specifies the extension type. You can use the Get-AzureRmVMExtensionImageType (./Get-AzureRmVMExtensionImageType.md)cmdlet to get the
extension type.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the extension to use for this virtual machine. You can use the Get-AzureRmVMExtensionImage
(./Get-AzureRmVMExtensionImage.md)cmdlet to get the version of the extension.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualMachineScaleSet <PSVirtualMachineScaleSet>
Specify the VMSS object. You can use the New-AzureRmVmssConfig (./New-AzureRmVmssConfig.md)to create the object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
VirtualMachineScaleSet
Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline
OUTPUTS
This cmdlet does not generate any output.
NOTES
Example 1: Add an extension to the VMSS
PS C:\\> Add-AzureRmVmssExtension -VirtualMachineScaleSet $VMSS -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer
-AutoUpgradeMinorVersion $True
This command adds an extension to the VMMS.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sextension
Remove-AzureRmVmssExtension
Get-AzureRmVMImagePublisher
Get-AzureRmVMExtensionImageType
Get-AzureRmVMExtensionImage
New-AzureRmVmssConfig