< Back

Get-AzureRmSqlDatabaseTransparentDataEncryption

Tue Jan 29, 2019 10:08 pm

NAME Get-AzureRmSqlDatabaseTransparentDataEncryption



SYNOPSIS

Gets the TDE state for a database.





SYNTAX

Get-AzureRmSqlDatabaseTransparentDataEncryption [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmSqlDatabaseTransparentDataEncryption cmdlet gets the state of Transparent Data Encryption (TDE) for an Azure SQL database. For more

information, see Transparent Data Encryption with Azure SQL Databasehttps://msdn.microsoft.com/library/dn948096

(https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. This cmdlet gets the current state of TDE, but both

encryption and decryption can be long-running operations. To see the encryption scan progress, run the

Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity cmdlet.



This cmdlet is also supported by the SQL Server Stretch Database service on Azure.





PARAMETERS

-DatabaseName <String>

Specifies the name of the database for which this cmdlet gets TDE status.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-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



-ResourceGroupName <String>

Specifies the name of the resource group to which the database is assigned.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ServerName <String>

Specifies the name of the server that hosts the database for which this cmdlet gets TDE status.



Required? true

Position? 1

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

Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel







NOTES









Example 1: Get TDE status for a database



PS C:\\>Get-AzureRmSqlDatabaseTransparentDataEncryption -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01"

ResourceGroupName ServerName DatabaseName State

----------------- ---------- ------------ -----

resourcegroup01 server01 database01 Disabled



This command gets the status of TDE for the database named Database01 on the server named server01.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... encryption

Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity

Set-AzureRmSqlDatabaseTransparentDataEncryption