Docs
PackagesWe recommend using Azure Native.
azure.mssql.ServerTransparentDataEncryption
Explore with Pulumi AI
Manages the transparent data encryption configuration for a MSSQL Server
NOTE: Once transparent data encryption is enabled on a MS SQL instance, it is not possible to remove TDE. You will be able to switch between ‘ServiceManaged’ and ‘CustomerManaged’ keys, but will not be able to remove encryption. For safety when this resource is deleted, the TDE mode will automatically be set to ‘ServiceManaged’. See
key_vault_urifor more information on how to specify the key types. As SQL Server only supports a single configuration for encryption settings, this resource will replace the current encryption settings on the server.
Note: See documentation for important information on how handle lifecycle management of the keys to prevent data lockout.
Example Usage
With Service Managed Key
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "EastUs",
});
var exampleServer = new Azure.MSSql.Server("exampleServer", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Version = "12.0",
AdministratorLogin = "missadministrator",
AdministratorLoginPassword = "thisIsKat11",
MinimumTlsVersion = "1.2",
AzureadAdministrator = new Azure.MSSql.Inputs.ServerAzureadAdministratorArgs
{
LoginUsername = "AzureAD Admin",
ObjectId = "00000000-0000-0000-0000-000000000000",
},
Tags =
{
{ "environment", "production" },
},
});
var exampleServerTransparentDataEncryption = new Azure.MSSql.ServerTransparentDataEncryption("exampleServerTransparentDataEncryption", new()
{
ServerId = exampleServer.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mssql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("EastUs"),
})
if err != nil {
return err
}
exampleServer, err := mssql.NewServer(ctx, "exampleServer", &mssql.ServerArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Version: pulumi.String("12.0"),
AdministratorLogin: pulumi.String("missadministrator"),
AdministratorLoginPassword: pulumi.String("thisIsKat11"),
MinimumTlsVersion: pulumi.String("1.2"),
AzureadAdministrator: &mssql.ServerAzureadAdministratorArgs{
LoginUsername: pulumi.String("AzureAD Admin"),
ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
},
Tags: pulumi.StringMap{
"environment": pulumi.String("production"),
},
})
if err != nil {
return err
}
_, err = mssql.NewServerTransparentDataEncryption(ctx, "exampleServerTransparentDataEncryption", &mssql.ServerTransparentDataEncryptionArgs{
ServerId: exampleServer.ID(),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.mssql.Server;
import com.pulumi.azure.mssql.ServerArgs;
import com.pulumi.azure.mssql.inputs.ServerAzureadAdministratorArgs;
import com.pulumi.azure.mssql.ServerTransparentDataEncryption;
import com.pulumi.azure.mssql.ServerTransparentDataEncryptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("EastUs")
.build());
var exampleServer = new Server("exampleServer", ServerArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.version("12.0")
.administratorLogin("missadministrator")
.administratorLoginPassword("thisIsKat11")
.minimumTlsVersion("1.2")
.azureadAdministrator(ServerAzureadAdministratorArgs.builder()
.loginUsername("AzureAD Admin")
.objectId("00000000-0000-0000-0000-000000000000")
.build())
.tags(Map.of("environment", "production"))
.build());
var exampleServerTransparentDataEncryption = new ServerTransparentDataEncryption("exampleServerTransparentDataEncryption", ServerTransparentDataEncryptionArgs.builder()
.serverId(exampleServer.id())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="EastUs")
example_server = azure.mssql.Server("exampleServer",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
version="12.0",
administrator_login="missadministrator",
administrator_login_password="thisIsKat11",
minimum_tls_version="1.2",
azuread_administrator=azure.mssql.ServerAzureadAdministratorArgs(
login_username="AzureAD Admin",
object_id="00000000-0000-0000-0000-000000000000",
),
tags={
"environment": "production",
})
example_server_transparent_data_encryption = azure.mssql.ServerTransparentDataEncryption("exampleServerTransparentDataEncryption", server_id=example_server.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "EastUs"});
const exampleServer = new azure.mssql.Server("exampleServer", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
version: "12.0",
administratorLogin: "missadministrator",
administratorLoginPassword: "thisIsKat11",
minimumTlsVersion: "1.2",
azureadAdministrator: {
loginUsername: "AzureAD Admin",
objectId: "00000000-0000-0000-0000-000000000000",
},
tags: {
environment: "production",
},
});
const exampleServerTransparentDataEncryption = new azure.mssql.ServerTransparentDataEncryption("exampleServerTransparentDataEncryption", {serverId: exampleServer.id});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: EastUs
exampleServer:
type: azure:mssql:Server
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
version: '12.0'
administratorLogin: missadministrator
administratorLoginPassword: thisIsKat11
minimumTlsVersion: '1.2'
azureadAdministrator:
loginUsername: AzureAD Admin
objectId: 00000000-0000-0000-0000-000000000000
tags:
environment: production
exampleServerTransparentDataEncryption:
type: azure:mssql:ServerTransparentDataEncryption
properties:
serverId: ${exampleServer.id}
With Customer Managed Key
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var current = Azure.Core.GetClientConfig.Invoke();
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "EastUs",
});
var exampleServer = new Azure.MSSql.Server("exampleServer", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Version = "12.0",
AdministratorLogin = "missadministrator",
AdministratorLoginPassword = "thisIsKat11",
MinimumTlsVersion = "1.2",
AzureadAdministrator = new Azure.MSSql.Inputs.ServerAzureadAdministratorArgs
{
LoginUsername = "AzureAD Admin",
ObjectId = "00000000-0000-0000-0000-000000000000",
},
Tags =
{
{ "environment", "production" },
},
Identity = new Azure.MSSql.Inputs.ServerIdentityArgs
{
Type = "SystemAssigned",
},
});
// Create a key vault with policies for the deployer to create a key & SQL Server to wrap/unwrap/get key
var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
EnabledForDiskEncryption = true,
TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
SoftDeleteRetentionDays = 7,
PurgeProtectionEnabled = false,
SkuName = "standard",
AccessPolicies = new[]
{
new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
{
TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
KeyPermissions = new[]
{
"Get",
"List",
"Create",
"Delete",
"Update",
"Recover",
"Purge",
"GetRotationPolicy",
},
},
new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
{
TenantId = exampleServer.Identity.Apply(identity => identity?.TenantId),
ObjectId = exampleServer.Identity.Apply(identity => identity?.PrincipalId),
KeyPermissions = new[]
{
"Get",
"WrapKey",
"UnwrapKey",
},
},
},
});
var exampleKey = new Azure.KeyVault.Key("exampleKey", new()
{
KeyVaultId = exampleKeyVault.Id,
KeyType = "RSA",
KeySize = 2048,
KeyOpts = new[]
{
"unwrapKey",
"wrapKey",
},
}, new CustomResourceOptions
{
DependsOn = new[]
{
exampleKeyVault,
},
});
var exampleServerTransparentDataEncryption = new Azure.MSSql.ServerTransparentDataEncryption("exampleServerTransparentDataEncryption", new()
{
ServerId = exampleServer.Id,
KeyVaultKeyId = exampleKey.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/keyvault"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mssql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := core.GetClientConfig(ctx, nil, nil)
if err != nil {
return err
}
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("EastUs"),
})
if err != nil {
return err
}
exampleServer, err := mssql.NewServer(ctx, "exampleServer", &mssql.ServerArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Version: pulumi.String("12.0"),
AdministratorLogin: pulumi.String("missadministrator"),
AdministratorLoginPassword: pulumi.String("thisIsKat11"),
MinimumTlsVersion: pulumi.String("1.2"),
AzureadAdministrator: &mssql.ServerAzureadAdministratorArgs{
LoginUsername: pulumi.String("AzureAD Admin"),
ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
},
Tags: pulumi.StringMap{
"environment": pulumi.String("production"),
},
Identity: &mssql.ServerIdentityArgs{
Type: pulumi.String("SystemAssigned"),
},
})
if err != nil {
return err
}
exampleKeyVault, err := keyvault.NewKeyVault(ctx, "exampleKeyVault", &keyvault.KeyVaultArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
EnabledForDiskEncryption: pulumi.Bool(true),
TenantId: *pulumi.String(current.TenantId),
SoftDeleteRetentionDays: pulumi.Int(7),
PurgeProtectionEnabled: pulumi.Bool(false),
SkuName: pulumi.String("standard"),
AccessPolicies: keyvault.KeyVaultAccessPolicyArray{
&keyvault.KeyVaultAccessPolicyArgs{
TenantId: *pulumi.String(current.TenantId),
ObjectId: *pulumi.String(current.ObjectId),
KeyPermissions: pulumi.StringArray{
pulumi.String("Get"),
pulumi.String("List"),
pulumi.String("Create"),
pulumi.String("Delete"),
pulumi.String("Update"),
pulumi.String("Recover"),
pulumi.String("Purge"),
pulumi.String("GetRotationPolicy"),
},
},
&keyvault.KeyVaultAccessPolicyArgs{
TenantId: exampleServer.Identity.ApplyT(func(identity mssql.ServerIdentity) (*string, error) {
return &identity.TenantId, nil
}).(pulumi.StringPtrOutput),
ObjectId: exampleServer.Identity.ApplyT(func(identity mssql.ServerIdentity) (*string, error) {
return &identity.PrincipalId, nil
}).(pulumi.StringPtrOutput),
KeyPermissions: pulumi.StringArray{
pulumi.String("Get"),
pulumi.String("WrapKey"),
pulumi.String("UnwrapKey"),
},
},
},
})
if err != nil {
return err
}
exampleKey, err := keyvault.NewKey(ctx, "exampleKey", &keyvault.KeyArgs{
KeyVaultId: exampleKeyVault.ID(),
KeyType: pulumi.String("RSA"),
KeySize: pulumi.Int(2048),
KeyOpts: pulumi.StringArray{
pulumi.String("unwrapKey"),
pulumi.String("wrapKey"),
},
}, pulumi.DependsOn([]pulumi.Resource{
exampleKeyVault,
}))
if err != nil {
return err
}
_, err = mssql.NewServerTransparentDataEncryption(ctx, "exampleServerTransparentDataEncryption", &mssql.ServerTransparentDataEncryptionArgs{
ServerId: exampleServer.ID(),
KeyVaultKeyId: exampleKey.ID(),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.mssql.Server;
import com.pulumi.azure.mssql.ServerArgs;
import com.pulumi.azure.mssql.inputs.ServerAzureadAdministratorArgs;
import com.pulumi.azure.mssql.inputs.ServerIdentityArgs;
import com.pulumi.azure.keyvault.KeyVault;
import com.pulumi.azure.keyvault.KeyVaultArgs;
import com.pulumi.azure.keyvault.inputs.KeyVaultAccessPolicyArgs;
import com.pulumi.azure.keyvault.Key;
import com.pulumi.azure.keyvault.KeyArgs;
import com.pulumi.azure.mssql.ServerTransparentDataEncryption;
import com.pulumi.azure.mssql.ServerTransparentDataEncryptionArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var current = CoreFunctions.getClientConfig();
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("EastUs")
.build());
var exampleServer = new Server("exampleServer", ServerArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.version("12.0")
.administratorLogin("missadministrator")
.administratorLoginPassword("thisIsKat11")
.minimumTlsVersion("1.2")
.azureadAdministrator(ServerAzureadAdministratorArgs.builder()
.loginUsername("AzureAD Admin")
.objectId("00000000-0000-0000-0000-000000000000")
.build())
.tags(Map.of("environment", "production"))
.identity(ServerIdentityArgs.builder()
.type("SystemAssigned")
.build())
.build());
var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.enabledForDiskEncryption(true)
.tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
.softDeleteRetentionDays(7)
.purgeProtectionEnabled(false)
.skuName("standard")
.accessPolicies(
KeyVaultAccessPolicyArgs.builder()
.tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
.objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
.keyPermissions(
"Get",
"List",
"Create",
"Delete",
"Update",
"Recover",
"Purge",
"GetRotationPolicy")
.build(),
KeyVaultAccessPolicyArgs.builder()
.tenantId(exampleServer.identity().applyValue(identity -> identity.tenantId()))
.objectId(exampleServer.identity().applyValue(identity -> identity.principalId()))
.keyPermissions(
"Get",
"WrapKey",
"UnwrapKey")
.build())
.build());
var exampleKey = new Key("exampleKey", KeyArgs.builder()
.keyVaultId(exampleKeyVault.id())
.keyType("RSA")
.keySize(2048)
.keyOpts(
"unwrapKey",
"wrapKey")
.build(), CustomResourceOptions.builder()
.dependsOn(exampleKeyVault)
.build());
var exampleServerTransparentDataEncryption = new ServerTransparentDataEncryption("exampleServerTransparentDataEncryption", ServerTransparentDataEncryptionArgs.builder()
.serverId(exampleServer.id())
.keyVaultKeyId(exampleKey.id())
.build());
}
}
import pulumi
import pulumi_azure as azure
current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="EastUs")
example_server = azure.mssql.Server("exampleServer",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
version="12.0",
administrator_login="missadministrator",
administrator_login_password="thisIsKat11",
minimum_tls_version="1.2",
azuread_administrator=azure.mssql.ServerAzureadAdministratorArgs(
login_username="AzureAD Admin",
object_id="00000000-0000-0000-0000-000000000000",
),
tags={
"environment": "production",
},
identity=azure.mssql.ServerIdentityArgs(
type="SystemAssigned",
))
# Create a key vault with policies for the deployer to create a key & SQL Server to wrap/unwrap/get key
example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
enabled_for_disk_encryption=True,
tenant_id=current.tenant_id,
soft_delete_retention_days=7,
purge_protection_enabled=False,
sku_name="standard",
access_policies=[
azure.keyvault.KeyVaultAccessPolicyArgs(
tenant_id=current.tenant_id,
object_id=current.object_id,
key_permissions=[
"Get",
"List",
"Create",
"Delete",
"Update",
"Recover",
"Purge",
"GetRotationPolicy",
],
),
azure.keyvault.KeyVaultAccessPolicyArgs(
tenant_id=example_server.identity.tenant_id,
object_id=example_server.identity.principal_id,
key_permissions=[
"Get",
"WrapKey",
"UnwrapKey",
],
),
])
example_key = azure.keyvault.Key("exampleKey",
key_vault_id=example_key_vault.id,
key_type="RSA",
key_size=2048,
key_opts=[
"unwrapKey",
"wrapKey",
],
opts=pulumi.ResourceOptions(depends_on=[example_key_vault]))
example_server_transparent_data_encryption = azure.mssql.ServerTransparentDataEncryption("exampleServerTransparentDataEncryption",
server_id=example_server.id,
key_vault_key_id=example_key.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "EastUs"});
const exampleServer = new azure.mssql.Server("exampleServer", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
version: "12.0",
administratorLogin: "missadministrator",
administratorLoginPassword: "thisIsKat11",
minimumTlsVersion: "1.2",
azureadAdministrator: {
loginUsername: "AzureAD Admin",
objectId: "00000000-0000-0000-0000-000000000000",
},
tags: {
environment: "production",
},
identity: {
type: "SystemAssigned",
},
});
// Create a key vault with policies for the deployer to create a key & SQL Server to wrap/unwrap/get key
const exampleKeyVault = new azure.keyvault.KeyVault("exampleKeyVault", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
enabledForDiskEncryption: true,
tenantId: current.then(current => current.tenantId),
softDeleteRetentionDays: 7,
purgeProtectionEnabled: false,
skuName: "standard",
accessPolicies: [
{
tenantId: current.then(current => current.tenantId),
objectId: current.then(current => current.objectId),
keyPermissions: [
"Get",
"List",
"Create",
"Delete",
"Update",
"Recover",
"Purge",
"GetRotationPolicy",
],
},
{
tenantId: exampleServer.identity.apply(identity => identity?.tenantId),
objectId: exampleServer.identity.apply(identity => identity?.principalId),
keyPermissions: [
"Get",
"WrapKey",
"UnwrapKey",
],
},
],
});
const exampleKey = new azure.keyvault.Key("exampleKey", {
keyVaultId: exampleKeyVault.id,
keyType: "RSA",
keySize: 2048,
keyOpts: [
"unwrapKey",
"wrapKey",
],
}, {
dependsOn: [exampleKeyVault],
});
const exampleServerTransparentDataEncryption = new azure.mssql.ServerTransparentDataEncryption("exampleServerTransparentDataEncryption", {
serverId: exampleServer.id,
keyVaultKeyId: exampleKey.id,
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: EastUs
exampleServer:
type: azure:mssql:Server
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
version: '12.0'
administratorLogin: missadministrator
administratorLoginPassword: thisIsKat11
minimumTlsVersion: '1.2'
azureadAdministrator:
loginUsername: AzureAD Admin
objectId: 00000000-0000-0000-0000-000000000000
tags:
environment: production
identity:
type: SystemAssigned
# Create a key vault with policies for the deployer to create a key & SQL Server to wrap/unwrap/get key
exampleKeyVault:
type: azure:keyvault:KeyVault
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
enabledForDiskEncryption: true
tenantId: ${current.tenantId}
softDeleteRetentionDays: 7
purgeProtectionEnabled: false
skuName: standard
accessPolicies:
- tenantId: ${current.tenantId}
objectId: ${current.objectId}
keyPermissions:
- Get
- List
- Create
- Delete
- Update
- Recover
- Purge
- GetRotationPolicy
- tenantId: ${exampleServer.identity.tenantId}
objectId: ${exampleServer.identity.principalId}
keyPermissions:
- Get
- WrapKey
- UnwrapKey
exampleKey:
type: azure:keyvault:Key
properties:
keyVaultId: ${exampleKeyVault.id}
keyType: RSA
keySize: 2048
keyOpts:
- unwrapKey
- wrapKey
options:
dependson:
- ${exampleKeyVault}
exampleServerTransparentDataEncryption:
type: azure:mssql:ServerTransparentDataEncryption
properties:
serverId: ${exampleServer.id}
keyVaultKeyId: ${exampleKey.id}
variables:
current:
fn::invoke:
Function: azure:core:getClientConfig
Arguments: {}
Create ServerTransparentDataEncryption Resource
new ServerTransparentDataEncryption(name: string, args: ServerTransparentDataEncryptionArgs, opts?: CustomResourceOptions);@overload
def ServerTransparentDataEncryption(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_rotation_enabled: Optional[bool] = None,
key_vault_key_id: Optional[str] = None,
server_id: Optional[str] = None)
@overload
def ServerTransparentDataEncryption(resource_name: str,
args: ServerTransparentDataEncryptionArgs,
opts: Optional[ResourceOptions] = None)func NewServerTransparentDataEncryption(ctx *Context, name string, args ServerTransparentDataEncryptionArgs, opts ...ResourceOption) (*ServerTransparentDataEncryption, error)public ServerTransparentDataEncryption(string name, ServerTransparentDataEncryptionArgs args, CustomResourceOptions? opts = null)
public ServerTransparentDataEncryption(String name, ServerTransparentDataEncryptionArgs args)
public ServerTransparentDataEncryption(String name, ServerTransparentDataEncryptionArgs args, CustomResourceOptions options)
type: azure:mssql:ServerTransparentDataEncryption
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServerTransparentDataEncryptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ServerTransparentDataEncryptionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ServerTransparentDataEncryptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServerTransparentDataEncryptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServerTransparentDataEncryptionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ServerTransparentDataEncryption Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ServerTransparentDataEncryption resource accepts the following input properties:
- Server
Id string Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- Auto
Rotation boolEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- Key
Vault stringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.
- Server
Id string Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- Auto
Rotation boolEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- Key
Vault stringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.
- server
Id String Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto
Rotation BooleanEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key
Vault StringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.
- server
Id string Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto
Rotation booleanEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key
Vault stringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.
- server_
id str Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto_
rotation_ boolenabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key_
vault_ strkey_ id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.
- server
Id String Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto
Rotation BooleanEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key
Vault StringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServerTransparentDataEncryption resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing ServerTransparentDataEncryption Resource
Get an existing ServerTransparentDataEncryption resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServerTransparentDataEncryptionState, opts?: CustomResourceOptions): ServerTransparentDataEncryption@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_rotation_enabled: Optional[bool] = None,
key_vault_key_id: Optional[str] = None,
server_id: Optional[str] = None) -> ServerTransparentDataEncryptionfunc GetServerTransparentDataEncryption(ctx *Context, name string, id IDInput, state *ServerTransparentDataEncryptionState, opts ...ResourceOption) (*ServerTransparentDataEncryption, error)public static ServerTransparentDataEncryption Get(string name, Input<string> id, ServerTransparentDataEncryptionState? state, CustomResourceOptions? opts = null)public static ServerTransparentDataEncryption get(String name, Output<String> id, ServerTransparentDataEncryptionState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Auto
Rotation boolEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- Key
Vault stringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.- Server
Id string Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- Auto
Rotation boolEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- Key
Vault stringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.- Server
Id string Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto
Rotation BooleanEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key
Vault StringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.- server
Id String Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto
Rotation booleanEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key
Vault stringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.- server
Id string Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto_
rotation_ boolenabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key_
vault_ strkey_ id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.- server_
id str Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
- auto
Rotation BooleanEnabled When enabled, the server will continuously check the key vault for any new versions of the key being used as the TDE protector. If a new version of the key is detected, the TDE protector on the server will be automatically rotated to the latest key version within 60 minutes.
- key
Vault StringKey Id To use customer managed keys from Azure Key Vault, provide the AKV Key ID. To use service managed keys, omit this field.
NOTE: In order to use customer managed keys, the identity of the MSSQL server must have the following permissions on the key vault: 'get', 'wrapKey' and 'unwrapKey'
NOTE: If
server_iddenotes a secondary server deployed for disaster recovery purposes, then thekey_vault_key_idshould be the same key used for the primary server's transparent data encryption. Both primary and secondary servers should be encrypted with same key material.- server
Id String Specifies the name of the MS SQL Server. Changing this forces a new resource to be created.
Import
SQL Server Transparent Data Encryption can be imported using the resource id, e.g.
$ pulumi import azure:mssql/serverTransparentDataEncryption:ServerTransparentDataEncryption example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/encryptionProtector/current
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.