< Back
Set-AzureRmSqlServerTransparentDataEncryptionProtector
Post
NAME Set-AzureRmSqlServerTransparentDataEncryptionProtector
SYNOPSIS
Sets the Transparent Data Encryption (TDE) protector for a SQL server.
SYNTAX
Set-AzureRmSqlServerTransparentDataEncryptionProtector [-ResourceGroupName] <String> [-ServerName] <String> [-Type] {AzureKeyVault |
ServiceManaged} [[-KeyId] <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmSqlServerTransparentDataEncryptionProtector cmdlet sets the TDE protector for a SQL server. Changing the TDE protector type will
rotate the protector.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background
Required? false
Position? named
Default value False
Accept pipeline input? False
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
-Force [<SwitchParameter>]
Skip confirmation message for performing the action
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-KeyId <String>
The Azure Key Vault KeyId.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The name of the resource group
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServerName <String>
The Azure Sql Server name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <EncryptionProtectorType>
The Azure Sql Database TDE protector type.
Required? true
Position? 2
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
Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.EncryptionProtectorType
System.String
OUTPUTS
System.Object
NOTES
Example 1: Set the Transparent Data Encryption (TDE) protector type to ServiceManaged
PS C:\\> Set-AzureRmSqlServerTransparentDataEncryptionProtector -Type ServiceManaged -ServerName 'ContosoServer' -ResourceGroup
'ContosoResourceGroup'
This command updates a server's TDE protector type to Service Managed.
ResourceGroupName ServerName Type ServerKeyVaultKeyName ----------------- ---------- ----
--------------------- ContosoResourceGroup ContosoServer ServiceManaged ServiceManaged
Example 2: Set the Transparent Data Encryption protector type to Azure Key Vault
PS C:\\> Set-AzureRmSqlServerTransparentDataEncryptionProtector -Type AzureKeyVault -KeyId
'https://contoso.vault.azure.net/keys/co ... 2345678901' -ServerName 'ContosoServer' -ResourceGroup
'ContosoResourceGroup'
This command updates a server to use the Server Key Vault Key with Id
'https://contoso.vault.azure.net/keys/co ... 2345678901' as the TDE protector.
ResourceGroupName ServerName Type ServerKeyVaultKeyName ----------------- ---------- ----
--------------------- ContosoResourceGroup ContosoServer AzureKeyVault contoso_contosokey_01234567890123456789012345678901
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nprotector
SQL Database Documentation https://docs.microsoft.com/azure/sql-database/
SYNOPSIS
Sets the Transparent Data Encryption (TDE) protector for a SQL server.
SYNTAX
Set-AzureRmSqlServerTransparentDataEncryptionProtector [-ResourceGroupName] <String> [-ServerName] <String> [-Type] {AzureKeyVault |
ServiceManaged} [[-KeyId] <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmSqlServerTransparentDataEncryptionProtector cmdlet sets the TDE protector for a SQL server. Changing the TDE protector type will
rotate the protector.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background
Required? false
Position? named
Default value False
Accept pipeline input? False
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
-Force [<SwitchParameter>]
Skip confirmation message for performing the action
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-KeyId <String>
The Azure Key Vault KeyId.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The name of the resource group
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServerName <String>
The Azure Sql Server name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <EncryptionProtectorType>
The Azure Sql Database TDE protector type.
Required? true
Position? 2
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
Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.EncryptionProtectorType
System.String
OUTPUTS
System.Object
NOTES
Example 1: Set the Transparent Data Encryption (TDE) protector type to ServiceManaged
PS C:\\> Set-AzureRmSqlServerTransparentDataEncryptionProtector -Type ServiceManaged -ServerName 'ContosoServer' -ResourceGroup
'ContosoResourceGroup'
This command updates a server's TDE protector type to Service Managed.
ResourceGroupName ServerName Type ServerKeyVaultKeyName ----------------- ---------- ----
--------------------- ContosoResourceGroup ContosoServer ServiceManaged ServiceManaged
Example 2: Set the Transparent Data Encryption protector type to Azure Key Vault
PS C:\\> Set-AzureRmSqlServerTransparentDataEncryptionProtector -Type AzureKeyVault -KeyId
'https://contoso.vault.azure.net/keys/co ... 2345678901' -ServerName 'ContosoServer' -ResourceGroup
'ContosoResourceGroup'
This command updates a server to use the Server Key Vault Key with Id
'https://contoso.vault.azure.net/keys/co ... 2345678901' as the TDE protector.
ResourceGroupName ServerName Type ServerKeyVaultKeyName ----------------- ---------- ----
--------------------- ContosoResourceGroup ContosoServer AzureKeyVault contoso_contosokey_01234567890123456789012345678901
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nprotector
SQL Database Documentation https://docs.microsoft.com/azure/sql-database/