< Back
Get-AzureRmVMDiskEncryptionStatus
Post
NAME Get-AzureRmVMDiskEncryptionStatus
SYNOPSIS
Gets the encryption status of the virtual machine.
SYNTAX
Get-AzureRmVMDiskEncryptionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>]
[-ExtensionPublisherName <String>] [-ExtensionType <String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmVMDiskEncryptionStatus cmdlet gets the encryption status of the virtual machine. It displays the encryption status of the operating
system and data volumes. In addition to encryption status, it also displays the encryption secret URL, key encryption key URL, resource IDs of the
KeyVaults where the encryption key and key encryption key for operating system volume are present.
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
-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
-Name <String>
Required? false
Position? 2
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine.
Required? true
Position? 1
Default value None
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Extension.AzureDiskEncryption.AzureDiskEncryptionExtensionContext
NOTES
Example 1: Get the encryption status of a virtual machine
PS C:\\> Get-AzureRmVmDiskEncryptionStatus -ResourceGroupName "MyResourceGroup001" -VMName "VM001"
This command gets the encryption status of the virtual machine named VM001.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tionstatus
Remove-AzureRmVMDiskEncryptionExtension
Set-AzureRmVMDiskEncryptionExtension
SYNOPSIS
Gets the encryption status of the virtual machine.
SYNTAX
Get-AzureRmVMDiskEncryptionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>]
[-ExtensionPublisherName <String>] [-ExtensionType <String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmVMDiskEncryptionStatus cmdlet gets the encryption status of the virtual machine. It displays the encryption status of the operating
system and data volumes. In addition to encryption status, it also displays the encryption secret URL, key encryption key URL, resource IDs of the
KeyVaults where the encryption key and key encryption key for operating system volume are present.
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
-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
-Name <String>
Required? false
Position? 2
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine.
Required? true
Position? 1
Default value None
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Extension.AzureDiskEncryption.AzureDiskEncryptionExtensionContext
NOTES
Example 1: Get the encryption status of a virtual machine
PS C:\\> Get-AzureRmVmDiskEncryptionStatus -ResourceGroupName "MyResourceGroup001" -VMName "VM001"
This command gets the encryption status of the virtual machine named VM001.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tionstatus
Remove-AzureRmVMDiskEncryptionExtension
Set-AzureRmVMDiskEncryptionExtension