Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. TransparentDataEncryption
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.sql.TransparentDataEncryption

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

A logical database transparent data encryption state. Azure REST API version: 2021-11-01. Prior API version in Azure Native 1.x: 2014-04-01.

Other available API versions: 2014-04-01, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

Example Usage

Update a database's Transparent Data Encryption state with minimal parameters

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var transparentDataEncryption = new AzureNative.Sql.TransparentDataEncryption("transparentDataEncryption", new()
    {
        DatabaseName = "testdb",
        ResourceGroupName = "securitytde-42-rg",
        ServerName = "securitytde-42",
        State = AzureNative.Sql.TransparentDataEncryptionState.Enabled,
        TdeName = "current",
    });

});
Copy
package main

import (
	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewTransparentDataEncryption(ctx, "transparentDataEncryption", &sql.TransparentDataEncryptionArgs{
			DatabaseName:      pulumi.String("testdb"),
			ResourceGroupName: pulumi.String("securitytde-42-rg"),
			ServerName:        pulumi.String("securitytde-42"),
			State:             sql.TransparentDataEncryptionStateEnabled,
			TdeName:           pulumi.String("current"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.TransparentDataEncryption;
import com.pulumi.azurenative.sql.TransparentDataEncryptionArgs;
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 transparentDataEncryption = new TransparentDataEncryption("transparentDataEncryption", TransparentDataEncryptionArgs.builder()
            .databaseName("testdb")
            .resourceGroupName("securitytde-42-rg")
            .serverName("securitytde-42")
            .state("Enabled")
            .tdeName("current")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const transparentDataEncryption = new azure_native.sql.TransparentDataEncryption("transparentDataEncryption", {
    databaseName: "testdb",
    resourceGroupName: "securitytde-42-rg",
    serverName: "securitytde-42",
    state: azure_native.sql.TransparentDataEncryptionState.Enabled,
    tdeName: "current",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

transparent_data_encryption = azure_native.sql.TransparentDataEncryption("transparentDataEncryption",
    database_name="testdb",
    resource_group_name="securitytde-42-rg",
    server_name="securitytde-42",
    state=azure_native.sql.TransparentDataEncryptionState.ENABLED,
    tde_name="current")
Copy
resources:
  transparentDataEncryption:
    type: azure-native:sql:TransparentDataEncryption
    properties:
      databaseName: testdb
      resourceGroupName: securitytde-42-rg
      serverName: securitytde-42
      state: Enabled
      tdeName: current
Copy

Create TransparentDataEncryption Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TransparentDataEncryption(name: string, args: TransparentDataEncryptionArgs, opts?: CustomResourceOptions);
@overload
def TransparentDataEncryption(resource_name: str,
                              args: TransparentDataEncryptionArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def TransparentDataEncryption(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              database_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              server_name: Optional[str] = None,
                              state: Optional[TransparentDataEncryptionState] = None,
                              tde_name: Optional[str] = None)
func NewTransparentDataEncryption(ctx *Context, name string, args TransparentDataEncryptionArgs, opts ...ResourceOption) (*TransparentDataEncryption, error)
public TransparentDataEncryption(string name, TransparentDataEncryptionArgs args, CustomResourceOptions? opts = null)
public TransparentDataEncryption(String name, TransparentDataEncryptionArgs args)
public TransparentDataEncryption(String name, TransparentDataEncryptionArgs args, CustomResourceOptions options)

type: azure-native:sql:TransparentDataEncryption
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TransparentDataEncryptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TransparentDataEncryptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TransparentDataEncryptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TransparentDataEncryptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TransparentDataEncryptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var transparentDataEncryptionResource = new AzureNative.Sql.TransparentDataEncryption("transparentDataEncryptionResource", new()
{
    DatabaseName = "string",
    ResourceGroupName = "string",
    ServerName = "string",
    State = "Enabled",
    TdeName = "string",
});
Copy
example, err := sql.NewTransparentDataEncryption(ctx, "transparentDataEncryptionResource", &sql.TransparentDataEncryptionArgs{
	DatabaseName:      "string",
	ResourceGroupName: "string",
	ServerName:        "string",
	State:             "Enabled",
	TdeName:           "string",
})
Copy
var transparentDataEncryptionResource = new TransparentDataEncryption("transparentDataEncryptionResource", TransparentDataEncryptionArgs.builder()
    .databaseName("string")
    .resourceGroupName("string")
    .serverName("string")
    .state("Enabled")
    .tdeName("string")
    .build());
Copy
transparent_data_encryption_resource = azure_native.sql.TransparentDataEncryption("transparentDataEncryptionResource",
    database_name=string,
    resource_group_name=string,
    server_name=string,
    state=Enabled,
    tde_name=string)
Copy
const transparentDataEncryptionResource = new azure_native.sql.TransparentDataEncryption("transparentDataEncryptionResource", {
    databaseName: "string",
    resourceGroupName: "string",
    serverName: "string",
    state: "Enabled",
    tdeName: "string",
});
Copy
type: azure-native:sql:TransparentDataEncryption
properties:
    databaseName: string
    resourceGroupName: string
    serverName: string
    state: Enabled
    tdeName: string
Copy

TransparentDataEncryption Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TransparentDataEncryption resource accepts the following input properties:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the logical database for which the security alert policy is defined.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
State This property is required. Pulumi.AzureNative.Sql.TransparentDataEncryptionState
Specifies the state of the transparent data encryption.
TdeName Changes to this property will trigger replacement. string
The name of the transparent data encryption configuration.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the logical database for which the security alert policy is defined.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
State This property is required. TransparentDataEncryptionStateEnum
Specifies the state of the transparent data encryption.
TdeName Changes to this property will trigger replacement. string
The name of the transparent data encryption configuration.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the logical database for which the security alert policy is defined.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
state This property is required. TransparentDataEncryptionState
Specifies the state of the transparent data encryption.
tdeName Changes to this property will trigger replacement. String
The name of the transparent data encryption configuration.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the logical database for which the security alert policy is defined.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
state This property is required. TransparentDataEncryptionState
Specifies the state of the transparent data encryption.
tdeName Changes to this property will trigger replacement. string
The name of the transparent data encryption configuration.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the logical database for which the security alert policy is defined.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
state This property is required. TransparentDataEncryptionState
Specifies the state of the transparent data encryption.
tde_name Changes to this property will trigger replacement. str
The name of the transparent data encryption configuration.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the logical database for which the security alert policy is defined.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
state This property is required. "Enabled" | "Disabled"
Specifies the state of the transparent data encryption.
tdeName Changes to this property will trigger replacement. String
The name of the transparent data encryption configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the TransparentDataEncryption resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
Type string
Resource type.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
Type string
Resource type.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
type String
Resource type.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
type string
Resource type.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
type str
Resource type.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
type String
Resource type.

Supporting Types

TransparentDataEncryptionState
, TransparentDataEncryptionStateArgs

Enabled
Enabled
Disabled
Disabled
TransparentDataEncryptionStateEnabled
Enabled
TransparentDataEncryptionStateDisabled
Disabled
Enabled
Enabled
Disabled
Disabled
Enabled
Enabled
Disabled
Disabled
ENABLED
Enabled
DISABLED
Disabled
"Enabled"
Enabled
"Disabled"
Disabled

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:sql:TransparentDataEncryption current /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native