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 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	資料庫的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
tdeName	path	True	TransparentDataEncryptionName	透明數據加密組態的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
properties.state	True	TransparentDataEncryptionState	指定透明數據加密的狀態。
properties.scanState		TransparentDataEncryptionScanState	指定透明數據加密的加密掃描狀態。

回應

名稱	類型	Description
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 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
LogicalDatabaseTransparentDataEncryption	邏輯資料庫透明數據加密掃描狀態。
systemData	與建立和上次修改資源相關的元數據。
TransparentDataEncryptionName	透明數據加密組態的名稱。
TransparentDataEncryptionScanState	指定透明數據加密的加密掃描狀態。
TransparentDataEncryptionState	指定透明數據加密的狀態。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

LogicalDatabaseTransparentDataEncryption

Object

邏輯資料庫透明數據加密掃描狀態。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.scanState	TransparentDataEncryptionScanState	指定透明數據加密的加密掃描狀態。
properties.state	TransparentDataEncryptionState	指定透明數據加密的狀態。
systemData	systemData	Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。
type	string	資源的類型。 例如：「Microsoft。運算/虛擬機器」或「Microsoft」。儲存/儲存帳號」

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源上次修改的時間戳記 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TransparentDataEncryptionName

列舉型別

透明數據加密組態的名稱。

值	Description
current	當前的

TransparentDataEncryptionScanState

列舉型別

指定透明數據加密的加密掃描狀態。

值	Description
None	沒有
Resume	履歷
Running	Running
Suspend	暫止
Aborted	已中止
Completed	已完成

TransparentDataEncryptionState

列舉型別

指定透明數據加密的狀態。

值	Description
Enabled	已啟用
Disabled	Disabled