Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzSqlDatabaseTransparentDataEncryption
- Module:
- Az.Sql Module
Modifies TDE property for a database.
Syntax
Default (Default)
Set-AzSqlDatabaseTransparentDataEncryption
[-State] <TransparentDataEncryptionStateType>
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSqlDatabaseTransparentDataEncryption 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.
Examples
Example 1: Enable TDE for a database
Set-AzSqlDatabaseTransparentDataEncryption -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.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DatabaseName
Specifies the name of the database that this cmdlet modifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-ResourceGroupName
Specifies the name of the resource group to which the database is assigned.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServerName
Specifies the name of the server that hosts the database.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-State
Specifies the value of the TDE property. The acceptable values for this parameter are:
- Enabled
- Disabled
Parameter properties
| Type: | TransparentDataEncryptionStateType |
| Default value: | None |
| Accepted values: | Enabled, Disabled |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
TransparentDataEncryptionStateType
String
Outputs
AzureSqlDatabaseTransparentDataEncryptionModel
Related Links
Azure PowerShell
Feedback
Was this page helpful?