azure-native.sql.TransparentDataEncryption
A logical database transparent data encryption state.
Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2021-11-01.
Other available API versions: 2014-04-01, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.
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",
    });
});
package main
import (
	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v3"
	"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
	})
}
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());
    }
}
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",
});
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")
resources:
  transparentDataEncryption:
    type: azure-native:sql:TransparentDataEncryption
    properties:
      databaseName: testdb
      resourceGroupName: securitytde-42-rg
      serverName: securitytde-42
      state: Enabled
      tdeName: current
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 string
- The unique name of the resource.
- args TransparentDataEncryptionArgs
- 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 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 string
- The unique name of the resource.
- args TransparentDataEncryptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TransparentDataEncryptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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 = AzureNative.Sql.TransparentDataEncryptionState.Enabled,
    TdeName = "string",
});
example, err := sql.NewTransparentDataEncryption(ctx, "transparentDataEncryptionResource", &sql.TransparentDataEncryptionArgs{
	DatabaseName:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServerName:        pulumi.String("string"),
	State:             sql.TransparentDataEncryptionStateEnabled,
	TdeName:           pulumi.String("string"),
})
var transparentDataEncryptionResource = new TransparentDataEncryption("transparentDataEncryptionResource", TransparentDataEncryptionArgs.builder()
    .databaseName("string")
    .resourceGroupName("string")
    .serverName("string")
    .state("Enabled")
    .tdeName("string")
    .build());
transparent_data_encryption_resource = azure_native.sql.TransparentDataEncryption("transparentDataEncryptionResource",
    database_name="string",
    resource_group_name="string",
    server_name="string",
    state=azure_native.sql.TransparentDataEncryptionState.ENABLED,
    tde_name="string")
const transparentDataEncryptionResource = new azure_native.sql.TransparentDataEncryption("transparentDataEncryptionResource", {
    databaseName: "string",
    resourceGroupName: "string",
    serverName: "string",
    state: azure_native.sql.TransparentDataEncryptionState.Enabled,
    tdeName: "string",
});
type: azure-native:sql:TransparentDataEncryption
properties:
    databaseName: string
    resourceGroupName: string
    serverName: string
    state: Enabled
    tdeName: string
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 string
- The name of the logical database for which the security alert policy is defined.
- ResourceGroup stringName 
- 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 string
- The name of the server.
- State
Pulumi.Azure Native. Sql. Transparent Data Encryption State 
- Specifies the state of the transparent data encryption.
- TdeName string
- The name of the transparent data encryption configuration.
- DatabaseName string
- The name of the logical database for which the security alert policy is defined.
- ResourceGroup stringName 
- 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 string
- The name of the server.
- State
TransparentData Encryption State Enum 
- Specifies the state of the transparent data encryption.
- TdeName string
- The name of the transparent data encryption configuration.
- databaseName String
- The name of the logical database for which the security alert policy is defined.
- resourceGroup StringName 
- 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 String
- The name of the server.
- state
TransparentData Encryption State 
- Specifies the state of the transparent data encryption.
- tdeName String
- The name of the transparent data encryption configuration.
- databaseName string
- The name of the logical database for which the security alert policy is defined.
- resourceGroup stringName 
- 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 string
- The name of the server.
- state
TransparentData Encryption State 
- Specifies the state of the transparent data encryption.
- tdeName string
- The name of the transparent data encryption configuration.
- database_name str
- The name of the logical database for which the security alert policy is defined.
- resource_group_ strname 
- 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 str
- The name of the server.
- state
TransparentData Encryption State 
- Specifies the state of the transparent data encryption.
- tde_name str
- The name of the transparent data encryption configuration.
- databaseName String
- The name of the logical database for which the security alert policy is defined.
- resourceGroup StringName 
- 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 String
- The name of the server.
- state "Enabled" | "Disabled"
- Specifies the state of the transparent data encryption.
- tdeName 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:
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Type string
- Resource type.
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Type string
- Resource type.
- azureApi StringVersion 
- The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- type String
- Resource type.
- azureApi stringVersion 
- The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name.
- type string
- Resource type.
- azure_api_ strversion 
- The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name.
- type str
- Resource type.
- azureApi StringVersion 
- The Azure API version of the resource.
- 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
- TransparentData Encryption State Enabled 
- Enabled
- TransparentData Encryption State Disabled 
- 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} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
