< Back
Add-AzureRmVmssDiagnosticsExtension
Post
NAME Add-AzureRmVmssDiagnosticsExtension
SYNOPSIS
Adds a diagnostics extension to the VMSS.
SYNTAX
Add-AzureRmVmssDiagnosticsExtension [-VirtualMachineScaleSet] <VirtualMachineScaleSet> [-SettingFilePath] <String> [[-ProtectedSettingFilePath]
<String>] [[-Name] <String>] [[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] [-DefaultProfile <IAzureContextContainer>]
[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmVmssDiagnosticsExtension cmdlet adds a diagnostics extension to the Virtual Machine Scale Set (VMSS) instance.
PARAMETERS
-AutoUpgradeMinorVersion <Boolean>
Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension 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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of an extension.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProtectedSettingFilePath <String>
Specifies the path of the private configuration file.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SettingFilePath <String>
Specifies the path of the public configuration file.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the extension to use for this VMSS. To obtain the version, run the Get-AzureRmVMExtensionImage
(./Get-AzureRmVMExtensionImage.md)cmdlet with a value of Microsoft.Azure.Diagnostics for the PublisherName parameter and IaaSDiagnostics for
the Type parameter.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualMachineScaleSet <VirtualMachineScaleSet>
Specify the VMSS object. You can use the New-AzureRmVmssConfig (./New-AzureRmVmssConfig.md)cmdlet 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 a diagnostics extension to the VMSS
PS C:\\> Add-AzureRmVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -SettingFilePath $publicConfigPath -ProtectedSettingFilePath
$privateConfigPath -Name $extName -TypeHandlerVersion $typeVersion -AutoUpgradeMinorVersion $True -Force
This command adds a diagnostics extension to the VMSS.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sextension
Add-AzureRmVmssExtension
Remove-AzureRmVmssDiagnosticsExtension
Set-AzureRmVMDiagnosticsExtension
SYNOPSIS
Adds a diagnostics extension to the VMSS.
SYNTAX
Add-AzureRmVmssDiagnosticsExtension [-VirtualMachineScaleSet] <VirtualMachineScaleSet> [-SettingFilePath] <String> [[-ProtectedSettingFilePath]
<String>] [[-Name] <String>] [[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] [-DefaultProfile <IAzureContextContainer>]
[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmVmssDiagnosticsExtension cmdlet adds a diagnostics extension to the Virtual Machine Scale Set (VMSS) instance.
PARAMETERS
-AutoUpgradeMinorVersion <Boolean>
Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension 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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of an extension.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProtectedSettingFilePath <String>
Specifies the path of the private configuration file.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SettingFilePath <String>
Specifies the path of the public configuration file.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the extension to use for this VMSS. To obtain the version, run the Get-AzureRmVMExtensionImage
(./Get-AzureRmVMExtensionImage.md)cmdlet with a value of Microsoft.Azure.Diagnostics for the PublisherName parameter and IaaSDiagnostics for
the Type parameter.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualMachineScaleSet <VirtualMachineScaleSet>
Specify the VMSS object. You can use the New-AzureRmVmssConfig (./New-AzureRmVmssConfig.md)cmdlet 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 a diagnostics extension to the VMSS
PS C:\\> Add-AzureRmVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -SettingFilePath $publicConfigPath -ProtectedSettingFilePath
$privateConfigPath -Name $extName -TypeHandlerVersion $typeVersion -AutoUpgradeMinorVersion $True -Force
This command adds a diagnostics extension to the VMSS.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sextension
Add-AzureRmVmssExtension
Remove-AzureRmVmssDiagnosticsExtension
Set-AzureRmVMDiagnosticsExtension