Set-AzVMBootDiagnostic
Modifies boot diagnostics properties of a virtual machine.
Syntax
Set-AzVMBootDiagnostic
[-VM] <PSVirtualMachine>
[-Enable]
[-ResourceGroupName] <String>
[[-StorageAccountName] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzVMBootDiagnostic
[-VM] <PSVirtualMachine>
[-Disable]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Set-AzVMBootDiagnostic cmdlet modifies boot diagnostics properties of a virtual machine.
Examples
Example 1: Enable boot diagnostics
PS C:\> $VM = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "ContosoVM07"
PS C:\> Set-AzVMBootDiagnostic -VM $VM -Enable -ResourceGroupName "ResourceGroup11" -StorageAccountName "DiagnosticStorage"
The first command gets the virtual machine named ContosoVM07 by using Get-AzVM. The command stores it in the $VM variable.
The second command enables boot diagnostics for the virtual machine in $VM. Diagnostics data is stored in the specified account.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Disable
Indicates that this cmdlet disables the boot diagnostics for the virtual machine.
Type: | SwitchParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Enable
Indicates that this cmdlet enables the boot diagnostics for the virtual machine.
Type: | SwitchParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group of the virtual machine.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-StorageAccountName
Specifies the name of the storage account in which to save boot diagnostics data.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VM
Specifies the virtual machine for which this cmdlet changes boot diagnostics. To obtain a virtual machine object, use the Get-AzVM cmdlet.
Type: | PSVirtualMachine |
Aliases: | VMProfile |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
PSVirtualMachine
Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline