Set-AzureVMBGInfoExtension
Sets the BGInfo extension for a virtual machine.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.
Syntax
Set-AzureVMBGInfoExtension
[-Disable]
[[-ReferenceName] <String>]
[[-Version] <String>]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Set-AzureVMBGInfoExtension
[-Uninstall]
[[-ReferenceName] <String>]
[[-Version] <String>]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Description
The Set-AzureVMBGInfoExtension cmdlet sets the BGInfo extension for a virtual machine.
Examples
Example 1: Set the BGInfo extension for a virtual machine
PS C:\> Set-AzureVMBGInfoExtension -VM $VMThis command sets the BGInfo extension for the specified virtual machine as stored in the variable $VM.
Parameters
-Disable
Indicates that this cmdlet disables the extension state.
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InformationAction
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
| Type: | ActionPreference |
| Aliases: | infa |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InformationVariable
Specifies an information variable.
| Type: | String |
| Aliases: | iv |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReferenceName
Specifies the reference name of the BGInfo extension.
This parameter is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the virtual machine for the first time. You can specify the previously used reference name while updating the extension.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Uninstall
Indicates that this cmdlet uninstalls the BGInfo extension.
| Type: | SwitchParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Version
Specifies the version of the BGInfo extension.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VM
Specifies the persistent virtual machine object.
| Type: | IPersistentVM |
| Aliases: | InputObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |