Set-AzureVMBGInfoExtension

NAME Set-AzureVMBGInfoExtension



SYNOPSIS

Sets the BGInfo extension for a virtual machine.





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.





PARAMETERS

-Disable [<SwitchParameter>]

Indicates that this cmdlet disables the extension state.



Required? false

Position? 1

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ReferenceName <String>

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. The ReferenceName assigned to an

extension is returned by the Get-AzureVM cmdlet.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Version <String>

Specifies the version of the BGInfo extension.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VM <IPersistentVM>

Specifies the persistent virtual machine object.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Uninstall [<SwitchParameter>]

Indicates that this cmdlet uninstalls the BGInfo extension.



Required? false

Position? 1

Default value False

Accept pipeline input? True (ByPropertyName)

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1: Set the BGInfo extension for a virtual machine --------------------------



PS C:\\>Set-AzureVMBGInfoExtension -VM $VM



This command sets the BGInfo extension for the specified virtual machine as stored in the variable $VM.



RELATED LINKS

Get-AzureVMBGInfoExtension

Remove-AzureVMBGInfoExtension