Get-AzureSqlDatabaseTransparentDataEncryption
Get-AzureSqlDatabaseTransparentDataEncryption
Gets the TPE state for an Azure SQL database.
Syntax
Parameter Set: Default
Get-AzureSqlDatabaseTransparentDataEncryption [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-Profile <AzureProfile> ] [ <CommonParameters>]
Detailed Description
The Get-AzureSqlDatabaseTransparentDataEncryption cmdlet gets the state of Transparent Data Encryption (TPE) from an Azure SQL database. For more information, see Transparent Data Encryption with Azure SQL Database (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. This cmdlet gets the current state of TPE, but both encryption and decryption can be long running operations. To see the encryption scan progress, run the Get-AzureSqlDatabaseTransparentDataEncryptionActivity cmdlet.
Parameters
-DatabaseName<String>
Specifies the name of the database for which this cmdlet gets TDE status.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Profile<AzureProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceGroupName<String>
Specifies the name of the resource group that contains the database for which this cmdlet gets TDE status.
Aliases |
none |
Required? |
true |
Position? |
1 |
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.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get TPE status for a database
This command gets the status of TPE for the database named Database01 on the server named Server12.
PS C:\> Get-AzureSqlDatabaseTransparentDataEncryption -ServerName "Server12" -ResourceGroupName "Default-SQL-WestUS" -DatabaseName "Database01"