< Back
Disable-AzureRmVMDiskEncryption
Post
NAME Disable-AzureRmVMDiskEncryption
SYNOPSIS
Disables encryption on an IaaS virtual machine.
SYNTAX
Disable-AzureRmVMDiskEncryption [-ResourceGroupName] <String> [-VMName] <String> [[-VolumeType] {OS | Data | All}] [[-Name] <String>]
[[-TypeHandlerVersion] <String>] [-DefaultProfile <IAzureContextContainer>] [-DisableAutoUpgradeMinorVersion] [-ExtensionPublisherName <String>]
[-ExtensionType <String>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Disable-AzureRmVMDiskEncryption cmdlet disables encryption on an infrastructure as a service (IaaS) virtual machine. This cmdlet is only
supported on Windows virtual machines and not Linux virtual machines. This cmdlet installs an extension on the virtual machine to disable
encryption. If the Name parameter is not specified, an extension with the default name "AzureDiskEncryption for Windows VMs" is created. Caution:
This cmdlet reboots the 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 disables auto-upgrade of the minor version of the extension.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionPublisherName <String>
The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security".
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionType <String>
The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and
"AzureDiskEncryptionForLinux" for Linux VMs.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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>
Specifes the name of the Azure Resource Manager (ARM) resource that represents the extension. If this parameter is not specified, this cmdlet
defaults to "AzureDiskEncryption for Windows VMs".
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the resource group name of the virtual machine.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the encryption extension. If you do not specify a value for this parameter, the latest version of the extension is
used.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine that this cmdlet disables encryption on.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VolumeType <String>
Specifies the type of virtual machine volumes to perform the encryption operation. For Windows virtual machines, valid values are:
- All
- OS
- Data.
If you do not specify a value for this parameter, the default value is All. Disable encryption is not currently supported for Linux.
Required? false
Position? 2
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
This cmdlet does not generate any output.
NOTES
Example 1: Disable encryption for all volumes on a Windows virtual machine
PS C:\\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group001" -VMName "VM002"
This command disables encryption for volumes of type all for the virtual machine named VM002 that belongs to the resource group named Group001.
Since the VolumeType parameter is not specified, the cmdlet sets the value to All.
Example 2: Disable encryption for data volumes on a Windows virtual machine
PS C:\\> $ResourceGroup = "Group002";
PS C:\\> $VMName = "VM004";
PS C:\\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group002" -VMName "VM004" -VolumeType "Data"
This command disables encryption for volumes of type data for the virtual machine named VM004 that belongs to the resource group named Group002.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... encryption
Get-AzureRmVMDiskEncryptionStatus
Remove-AzureRmVMDiskEncryptionExtension
Set-AzureRmVMDiskEncryptionExtension
SYNOPSIS
Disables encryption on an IaaS virtual machine.
SYNTAX
Disable-AzureRmVMDiskEncryption [-ResourceGroupName] <String> [-VMName] <String> [[-VolumeType] {OS | Data | All}] [[-Name] <String>]
[[-TypeHandlerVersion] <String>] [-DefaultProfile <IAzureContextContainer>] [-DisableAutoUpgradeMinorVersion] [-ExtensionPublisherName <String>]
[-ExtensionType <String>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Disable-AzureRmVMDiskEncryption cmdlet disables encryption on an infrastructure as a service (IaaS) virtual machine. This cmdlet is only
supported on Windows virtual machines and not Linux virtual machines. This cmdlet installs an extension on the virtual machine to disable
encryption. If the Name parameter is not specified, an extension with the default name "AzureDiskEncryption for Windows VMs" is created. Caution:
This cmdlet reboots the 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 disables auto-upgrade of the minor version of the extension.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionPublisherName <String>
The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security".
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionType <String>
The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and
"AzureDiskEncryptionForLinux" for Linux VMs.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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>
Specifes the name of the Azure Resource Manager (ARM) resource that represents the extension. If this parameter is not specified, this cmdlet
defaults to "AzureDiskEncryption for Windows VMs".
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the resource group name of the virtual machine.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TypeHandlerVersion <String>
Specifies the version of the encryption extension. If you do not specify a value for this parameter, the latest version of the extension is
used.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine that this cmdlet disables encryption on.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VolumeType <String>
Specifies the type of virtual machine volumes to perform the encryption operation. For Windows virtual machines, valid values are:
- All
- OS
- Data.
If you do not specify a value for this parameter, the default value is All. Disable encryption is not currently supported for Linux.
Required? false
Position? 2
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
This cmdlet does not generate any output.
NOTES
Example 1: Disable encryption for all volumes on a Windows virtual machine
PS C:\\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group001" -VMName "VM002"
This command disables encryption for volumes of type all for the virtual machine named VM002 that belongs to the resource group named Group001.
Since the VolumeType parameter is not specified, the cmdlet sets the value to All.
Example 2: Disable encryption for data volumes on a Windows virtual machine
PS C:\\> $ResourceGroup = "Group002";
PS C:\\> $VMName = "VM004";
PS C:\\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group002" -VMName "VM004" -VolumeType "Data"
This command disables encryption for volumes of type data for the virtual machine named VM004 that belongs to the resource group named Group002.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... encryption
Get-AzureRmVMDiskEncryptionStatus
Remove-AzureRmVMDiskEncryptionExtension
Set-AzureRmVMDiskEncryptionExtension