Transparent Data Encryptions - Create Or Update

服务:

SQL Database

API 版本:

2025-01-01

更新逻辑数据库的透明数据加密配置。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/current?api-version=2025-01-01

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
tdeName	path	True	TransparentDataEncryptionName	透明数据加密配置的名称。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
properties.state	True	TransparentDataEncryptionState	指定透明数据加密的状态。
properties.scanState		TransparentDataEncryptionScanState	指定透明数据加密的加密扫描状态。

响应

名称	类型	说明
200 OK	LogicalDatabaseTransparentDataEncryption	资源“LogicalDatabaseTransparentDataEncryption”更新操作成功
201 Created	LogicalDatabaseTransparentDataEncryption	资源“LogicalDatabaseTransparentDataEncryption”创建操作成功 标头 Azure-AsyncOperation: string
202 Accepted		已接受资源作。 标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

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

示例请求

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/servers/securitytde-42/databases/testdb/transparentDataEncryption/current?api-version=2025-01-01

{
  "properties": {
    "scanState": "Suspend",
    "state": "Enabled"
  }
}

Java

import com.azure.resourcemanager.sql.fluent.models.LogicalDatabaseTransparentDataEncryptionInner;
import com.azure.resourcemanager.sql.models.TransparentDataEncryptionName;
import com.azure.resourcemanager.sql.models.TransparentDataEncryptionScanState;
import com.azure.resourcemanager.sql.models.TransparentDataEncryptionState;

/**
 * Samples for TransparentDataEncryptions CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/TransparentDataEncryptionUpdate.json
     */
    /**
     * Sample code: Update a database's Transparent Data Encryption state with minimal parameters.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void updateADatabaseSTransparentDataEncryptionStateWithMinimalParameters(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getTransparentDataEncryptions().createOrUpdate("securitytde-42-rg", "securitytde-42",
            "testdb", TransparentDataEncryptionName.CURRENT,
            new LogicalDatabaseTransparentDataEncryptionInner().withState(TransparentDataEncryptionState.ENABLED)
                .withScanState(TransparentDataEncryptionScanState.SUSPEND),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python transparent_data_encryption_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.transparent_data_encryptions.begin_create_or_update(
        resource_group_name="securitytde-42-rg",
        server_name="securitytde-42",
        database_name="testdb",
        tde_name="current",
        parameters={"properties": {"scanState": "Suspend", "state": "Enabled"}},
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/TransparentDataEncryptionUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates a logical database's transparent data encryption configuration.
 *
 * @summary updates a logical database's transparent data encryption configuration.
 * x-ms-original-file: 2025-01-01/TransparentDataEncryptionUpdate.json
 */
async function updateADatabaseTransparentDataEncryptionStateWithMinimalParameters() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.transparentDataEncryptions.createOrUpdate(
    "securitytde-42-rg",
    "securitytde-42",
    "testdb",
    "current",
    { scanState: "Suspend", state: "Enabled" },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/TransparentDataEncryptionUpdate.json
// this example is just showing the usage of "TransparentDataEncryptions_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "securitytde-42-rg";
string serverName = "securitytde-42";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this LogicalDatabaseTransparentDataEncryptionResource
LogicalDatabaseTransparentDataEncryptionCollection collection = sqlDatabase.GetLogicalDatabaseTransparentDataEncryptions();

// invoke the operation
TransparentDataEncryptionName tdeName = TransparentDataEncryptionName.Current;
LogicalDatabaseTransparentDataEncryptionData data = new LogicalDatabaseTransparentDataEncryptionData
{
    State = TransparentDataEncryptionState.Enabled,
    ScanState = TransparentDataEncryptionScanState.Suspend,
};
ArmOperation<LogicalDatabaseTransparentDataEncryptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, tdeName, data);
LogicalDatabaseTransparentDataEncryptionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
LogicalDatabaseTransparentDataEncryptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/transparentDataEncryption",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/servers/securitytde-42/databases/testdb/transparentDataEncryption/current",
  "properties": {
    "scanState": "Suspend",
    "state": "Enabled"
  }
}

状态代码:

201

{
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/transparentDataEncryption",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/servers/securitytde-42/databases/testdb/transparentDataEncryption/current",
  "properties": {
    "scanState": "Suspend",
    "state": "Enabled"
  }
}

状态代码:

202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/locations/southeastasia/transparentDataEncryptionOperationResults/11111111-1111-1111-1111-111111111111

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LogicalDatabaseTransparentDataEncryption	逻辑数据库透明数据加密扫描状态。
systemData	与创建和上次修改资源相关的元数据。
TransparentDataEncryptionName	透明数据加密配置的名称。
TransparentDataEncryptionScanState	指定透明数据加密的加密扫描状态。
TransparentDataEncryptionState	指定透明数据加密的状态。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

LogicalDatabaseTransparentDataEncryption

对象

逻辑数据库透明数据加密扫描状态。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.scanState	TransparentDataEncryptionScanState	指定透明数据加密的加密扫描状态。
properties.state	TransparentDataEncryptionState	指定透明数据加密的状态。
systemData	systemData	Azure 资源管理器 包含 createdBy 和 modifiedBy 信息的元数据。
type	string	资源类型。 例如，“Microsoft。计算/虚拟机“或”Microsoft“。存储/存储账户”

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 （UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TransparentDataEncryptionName

枚举

透明数据加密配置的名称。

值	说明
current	当前

TransparentDataEncryptionScanState

枚举

指定透明数据加密的加密扫描状态。

值	说明
None	没有
Resume	继续
Running	Running
Suspend	挂起
Aborted	已中止
Completed	已完成

TransparentDataEncryptionState

枚举

指定透明数据加密的状态。

值	说明
Enabled	已启用
Disabled	已禁用