< Back
Set-AzureRmVMBginfoExtension
Post
NAME Set-AzureRmVMBginfoExtension
SYNOPSIS
Adds the BGInfo extension to a virtual machine.
SYNTAX
Set-AzureRmVMBginfoExtension [-ResourceGroupName] <String> [-VMName] <String> [-DefaultProfile <IAzureContextContainer>]
[-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-Location <String>] [-Name <String>] [-TypeHandlerVersion <String>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-AzureRmVMBGInfoExtension cmdlet adds the BGInfo extension to a virtual machine.
PARAMETERS
-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
-DisableAutoUpgradeMinorVersion [<SwitchParameter>]
Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extension to a newer minor version. By default, this
cmdlet enables the guest agent to update the extension.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ForceRerun <String>
Specifies that the extension should be run again with the same public or protected settings. The value can be any string different from the
current value.
If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Location <String>
Specifies the location of the virtual machine.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the BGInfo extension that this cmdlet adds to a virtual machine.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group of the virtual machine to which this cmdlet adds an extension.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the extension that this cmdlet adds to the virtual machine.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine to which this cmdlet adds the BGInfo extension.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse
NOTES
Example 1: Add the BGInfo extension for a virtual machine
PS C:\\> Set-AzureVMBGInfoExtension -ResrouceGroupName "ContosoRG" -VMName "ContosoVM" -Name "ExtensionName" -TypeHandlerVersion "2.1" -Location
"West Europe"
This command adds the BGInfo extension to virtual machine named ContosoVM. The command specifies the resource group and location of the virtual
machine. The command specifies the name and version of the extension.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... oextension
SYNOPSIS
Adds the BGInfo extension to a virtual machine.
SYNTAX
Set-AzureRmVMBginfoExtension [-ResourceGroupName] <String> [-VMName] <String> [-DefaultProfile <IAzureContextContainer>]
[-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-Location <String>] [-Name <String>] [-TypeHandlerVersion <String>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-AzureRmVMBGInfoExtension cmdlet adds the BGInfo extension to a virtual machine.
PARAMETERS
-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
-DisableAutoUpgradeMinorVersion [<SwitchParameter>]
Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extension to a newer minor version. By default, this
cmdlet enables the guest agent to update the extension.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ForceRerun <String>
Specifies that the extension should be run again with the same public or protected settings. The value can be any string different from the
current value.
If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Location <String>
Specifies the location of the virtual machine.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the BGInfo extension that this cmdlet adds to a virtual machine.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group of the virtual machine to which this cmdlet adds an extension.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the extension that this cmdlet adds to the virtual machine.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine to which this cmdlet adds the BGInfo extension.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse
NOTES
Example 1: Add the BGInfo extension for a virtual machine
PS C:\\> Set-AzureVMBGInfoExtension -ResrouceGroupName "ContosoRG" -VMName "ContosoVM" -Name "ExtensionName" -TypeHandlerVersion "2.1" -Location
"West Europe"
This command adds the BGInfo extension to virtual machine named ContosoVM. The command specifies the resource group and location of the virtual
machine. The command specifies the name and version of the extension.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... oextension