< Back

Set-AzureRmSqlDatabaseTransparentDataEncryption

Tue Jan 29, 2019 10:10 pm

NAME Set-AzureRmSqlDatabaseTransparentDataEncryption



SYNOPSIS

Modifies TDE property for a database.





SYNTAX

Set-AzureRmSqlDatabaseTransparentDataEncryption [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-State] {Enabled |

Disabled} [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmSqlDatabaseTransparentDataEncryption cmdlet modifies the Transparent Data Encryption (TDE) property of 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 is also supported by the SQL Server Stretch Database service on Azure.





PARAMETERS

-DatabaseName <String>

Specifies the name of the database that this cmdlet modifies.



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.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-State <TransparentDataEncryptionStateType>

Specifies the value of the TDE property. The acceptable values for this parameter are:



- Enabled



- Disabled



Required? true

Position? 3

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: Enable TDE for a database



PS C:\\>Set-AzureRmSqlDatabaseTransparentDataEncryption -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"

-State Enabled

ResourceGroupName ServerName DatabaseName State

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

ResourceGroup01 Server01 Database01 Enabled



This command enables TDE for the database named Database01 on the server named Server01.







RELATED LINKS

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

Get-AzureRmSqlDatabaseTransparentDataEncryption

Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity

SQL Database Documentation https://docs.microsoft.com/azure/sql-database/