你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Transparent Data Encryptions - Get

服务:: SQL Database

API 版本:: 2023-08-01

获取逻辑数据库的透明数据加密。

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

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	为其定义透明数据加密的逻辑数据库的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
tdeName	path	True	TransparentDataEncryptionName	透明数据加密配置的名称。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	LogicalDatabaseTransparentDataEncryption	已成功检索逻辑数据库透明数据加密。
Other Status Codes	ErrorResponse	错误响应： *** 400 SecurityAdalPrincipalCertExpiredError - 无法完成该作，因为 Azure Key Vault 主体证书已过期。 400 AkvHostNotResolvingFromNode - AKV 主机“{0}”无法从 SQL 解析，服务器“{1}”。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的 Key Vault URI 无效。 400 MissingKeyVaultUriForRestore - 成功还原服务器“{0}”下的数据库“{1}”所需的 Azure Key Vault 密钥 URI“{2}”。 400 AzureKeyVaultKeyUsedOnGeoPrimary - 无法完成该作，因为 Azure Key Vault 密钥名称 {0} 当前在异地主数据库上设置为加密保护程序。 400 KeyMaterialNotFoundOnRemoteServer - 远程服务器无权访问用作 TDE 保护程序的密钥材料。 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary - 异地复制中的所有数据库必须包含与源数据库的加密保护程序相同的密钥材料。请将具有相同密钥材料的密钥“{0}”添加到目标数据库“{1}”。 400 AzureKeyVaultRsaKeyNotSupported - 提供的密钥保管库使用不支持的 RSA 密钥大小或密钥类型。支持的 RSA 密钥大小为 2048 或 3072，密钥类型为 RSA 或 RSA-HSM。 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary - 启用数据库级别 TDE 保护程序的自动轮换时，源数据库和目标数据库必须连接到同一密钥保管库。请将密钥“{0}”（从连接到源数据库的同一密钥保管库）添加到目标数据库“{1}”。 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName - 尝试复制使用数据库级别加密保护程序配置的数据库时，主数据库正在使用的当前密钥必须传递给辅助数据库“{0}” 400 ManagedInstanceNoConditionToMakeDatabaseAccessible -作无法完成，因为没有足够的权限启动托管实例上的可访问工作流 {0}。 400 UmiMissingAkvPermissions - 用户提供的 PrimaryUserAssignedIdentityId 无权访问提供的 KeyId 400 SameKeyUriNotFoundOnRemoteServer - 辅助服务器没有与启用了密钥自动轮换的主服务器的加密保护程序相同的密钥保管库中的密钥材料。 400 SameKeyMaterialNotFoundOnRemoteServer - 辅助服务器没有主服务器的加密保护程序的密钥材料。 400 SecurityAzureKeyVaultGeoChainError - 使用 Azure Key Vault（BYOK）启用透明数据加密时不支持创建辅助数据库（称为链接的进程）。 400 PerDatabaseCMKDWNotSupported - Datawarehouse 版本不支持预览版的数据库级 CMK。 400 BlockSystemAssignedIdentityForCrossTenantCMK - 仅当服务器配置有用户分配的托管标识时，才能配置跨租户 CMK。请参阅 https://aka.ms/sqltdebyokumi 来配置用户分配的托管标识。 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - 尝试复制使用数据库级别加密保护程序配置的数据库时，主数据库正在使用的当前密钥必须传递给辅助数据库。 400 CannotDropDatabaseAKVError - 无法安全地删除服务器 {0} 上的数据库 {1}，因为它使用客户管理的密钥进行加密，该密钥在删除之前无法再进行上次备份。请在服务器上还原 Azure Key Vault 访问，并重新验证密钥以使此数据库可访问，然后继续删除。有关详细信息，请参阅 https://aka.ms/tdecmkrestorability 400 CreateDatabaseAttemptedWithRotationInProgress - 由于服务器上的透明数据加密（TDE）密钥轮换，目前无法执行创建数据库作。请稍后再次尝试该作。 400 AzureKeyVaultKeyDisabled - 无法在服务器上完成该作，因为 Azure Key Vault 密钥已禁用。 400 PerDatabaseCMKRestoreNotSupported - 在预览版中配置数据库级 CMK 时不支持数据库还原。 400 AzureKeyVaultInvalidExpirationDate - 无法完成该作，因为 Azure Key Vault 密钥到期日期无效。超大规模版本不支持 400 PerDatabaseCMKHSNotSupported - 预览版中的数据库级 CMK。 400 SecurityAzureKeyVaultUrlNullOrEmpty - 无法完成作，因为 Azure Key Vault URI 为 null 或为空。 400 CMKOperationNotAllowed - 当服务器没有 Azure Key Vault 访问时，用户尝试在服务器上执行作。 400 AkvEndpointNotReachableFromNode - AKV 终结点“{0}”无法从 SQL 访问，位于服务器“{1}”。 400 AzureKeyVaultNoServerIdentity - 服务器标识未正确配置。 400 AzureKeyVaultInvalidUri - 来自 Azure Key Vault 的无效响应。请使用有效的 Azure Key Vault URI。 400 AzureKeyVaultMissingPermissions - 服务器缺少对 Azure Key Vault 所需的权限。 400 AzureKeyVaultKeyNameCurrentlyInUse - 无法完成该作，因为 Azure Key Vault 密钥名称 {0} 当前正在使用中。 400 AzureKeyVaultKeyThumbprintIsDifferent - 无法完成该作，因为 Azure Key Vault 密钥材料不同于当前加密保护程序密钥。 400 SecurityAzureKeyVaultInvalidKeyName - 由于服务器密钥名称无效，无法完成该作。 400 OldGenerationOfAKVKeyBeingUsedError - 不允许将旧版 AKV 密钥用作 TDE 保护程序。请使用最新版本的 AKV 密钥作为加密保护程序 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - 未在目标数据库上设置 Per Database CMK 标识。 400 AdalGenericError - 由于遇到 Azure Active Directory 错误，无法完成该作。 400 AdalServicePrincipalNotFound - 无法完成该作，因为遇到 Azure Active Directory 库服务主体找不到错误。 400 AzureKeyVaultMalformedVaultUri - 提供的 Key Vault URI 无效。 400 AttemptedEncryptionOnSystemDatabase - 无法加密系统数据库。不能对“master”、“model”、“tempdb”、“msdb”或“resource”数据库执行数据库加密作。 400 ReadOnly - 无法在只读、具有只读文件或未恢复的数据库上启用或禁用数据库加密。 400 CanNotChangeReadOnlyDuringTdeScan - 在加密转换正在进行时无法修改文件组只读/读写状态。 400 CanNotDropAlterOnMirror - 请修改主数据库上的透明数据加密。 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作 409 ServerKeyNameAlreadyExists - 服务器上已存在服务器密钥。 409 ServerKeyUriAlreadyExists - 服务器上已存在服务器密钥 URI。 409 ServerKeyDoesNotExists - 服务器密钥不存在。 409 AzureKeyVaultKeyNameNotFound - 无法完成该作，因为 Azure Key Vault 密钥名称不存在。 409 AzureKeyVaultKeyInUse - 服务器当前正在使用密钥。 409 EncryptionInProgress - 在加密扫描过程中无法修改加密。 409 KeyChangeInProgress - 加密、解密或密钥更改扫描正在进行时无法更改数据库加密密钥。 409 NoBulkOperationLock - CREATE/ALTER/DROP DATABASE ENCRYPTION KEY 失败，因为无法将锁放置在数据库上。请稍后再试。 409 NeedsLogBackup - 请等待几分钟，以便进行日志备份。 409 AltStateConflict - 无法对数据库执行该作，因为它涉及数据库镜像会话或可用性组。不允许对参与数据库镜像会话或可用性组的数据库执行某些作。 503 AzureKeyVaultConnectionFailed - 无法在服务器上完成该作，因为尝试连接到 Azure Key Vault 失败 503 AzureKeyVaultGenericConnectionError - 无法完成该作，因为尝试检索 Key Vault 信息时遇到错误。 503 NoDekLock - CREATE/ALTER/DROP DATABASE ENCRYPTION KEY 失败，因为无法将锁放置在数据库上。请稍后再试。

名称

类型

说明

200 OK

LogicalDatabaseTransparentDataEncryption

已成功检索逻辑数据库透明数据加密。

Other Status Codes

ErrorResponse

错误响应： ***

400 SecurityAdalPrincipalCertExpiredError - 无法完成该作，因为 Azure Key Vault 主体证书已过期。
400 AkvHostNotResolvingFromNode - AKV 主机“{0}”无法从 SQL 解析，服务器“{1}”。
400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的 Key Vault URI 无效。
400 MissingKeyVaultUriForRestore - 成功还原服务器“{0}”下的数据库“{1}”所需的 Azure Key Vault 密钥 URI“{2}”。
400 AzureKeyVaultKeyUsedOnGeoPrimary - 无法完成该作，因为 Azure Key Vault 密钥名称 {0} 当前在异地主数据库上设置为加密保护程序。
400 KeyMaterialNotFoundOnRemoteServer - 远程服务器无权访问用作 TDE 保护程序的密钥材料。
400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary - 异地复制中的所有数据库必须包含与源数据库的加密保护程序相同的密钥材料。请将具有相同密钥材料的密钥“{0}”添加到目标数据库“{1}”。
400 AzureKeyVaultRsaKeyNotSupported - 提供的密钥保管库使用不支持的 RSA 密钥大小或密钥类型。支持的 RSA 密钥大小为 2048 或 3072，密钥类型为 RSA 或 RSA-HSM。
400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary - 启用数据库级别 TDE 保护程序的自动轮换时，源数据库和目标数据库必须连接到同一密钥保管库。请将密钥“{0}”（从连接到源数据库的同一密钥保管库）添加到目标数据库“{1}”。
400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName - 尝试复制使用数据库级别加密保护程序配置的数据库时，主数据库正在使用的当前密钥必须传递给辅助数据库“{0}”
400 ManagedInstanceNoConditionToMakeDatabaseAccessible -作无法完成，因为没有足够的权限启动托管实例上的可访问工作流 {0}。
400 UmiMissingAkvPermissions - 用户提供的 PrimaryUserAssignedIdentityId 无权访问提供的 KeyId
400 SameKeyUriNotFoundOnRemoteServer - 辅助服务器没有与启用了密钥自动轮换的主服务器的加密保护程序相同的密钥保管库中的密钥材料。
400 SameKeyMaterialNotFoundOnRemoteServer - 辅助服务器没有主服务器的加密保护程序的密钥材料。
400 SecurityAzureKeyVaultGeoChainError - 使用 Azure Key Vault（BYOK）启用透明数据加密时不支持创建辅助数据库（称为链接的进程）。
400 PerDatabaseCMKDWNotSupported - Datawarehouse 版本不支持预览版的数据库级 CMK。
400 BlockSystemAssignedIdentityForCrossTenantCMK - 仅当服务器配置有用户分配的托管标识时，才能配置跨租户 CMK。请参阅 https://aka.ms/sqltdebyokumi 来配置用户分配的托管标识。
400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - 尝试复制使用数据库级别加密保护程序配置的数据库时，主数据库正在使用的当前密钥必须传递给辅助数据库。
400 CannotDropDatabaseAKVError - 无法安全地删除服务器 {0} 上的数据库 {1}，因为它使用客户管理的密钥进行加密，该密钥在删除之前无法再进行上次备份。请在服务器上还原 Azure Key Vault 访问，并重新验证密钥以使此数据库可访问，然后继续删除。有关详细信息，请参阅 https://aka.ms/tdecmkrestorability
400 CreateDatabaseAttemptedWithRotationInProgress - 由于服务器上的透明数据加密（TDE）密钥轮换，目前无法执行创建数据库作。请稍后再次尝试该作。
400 AzureKeyVaultKeyDisabled - 无法在服务器上完成该作，因为 Azure Key Vault 密钥已禁用。
400 PerDatabaseCMKRestoreNotSupported - 在预览版中配置数据库级 CMK 时不支持数据库还原。
400 AzureKeyVaultInvalidExpirationDate - 无法完成该作，因为 Azure Key Vault 密钥到期日期无效。
超大规模版本不支持 400 PerDatabaseCMKHSNotSupported - 预览版中的数据库级 CMK。
400 SecurityAzureKeyVaultUrlNullOrEmpty - 无法完成作，因为 Azure Key Vault URI 为 null 或为空。
400 CMKOperationNotAllowed - 当服务器没有 Azure Key Vault 访问时，用户尝试在服务器上执行作。
400 AkvEndpointNotReachableFromNode - AKV 终结点“{0}”无法从 SQL 访问，位于服务器“{1}”。
400 AzureKeyVaultNoServerIdentity - 服务器标识未正确配置。
400 AzureKeyVaultInvalidUri - 来自 Azure Key Vault 的无效响应。请使用有效的 Azure Key Vault URI。
400 AzureKeyVaultMissingPermissions - 服务器缺少对 Azure Key Vault 所需的权限。
400 AzureKeyVaultKeyNameCurrentlyInUse - 无法完成该作，因为 Azure Key Vault 密钥名称 {0} 当前正在使用中。
400 AzureKeyVaultKeyThumbprintIsDifferent - 无法完成该作，因为 Azure Key Vault 密钥材料不同于当前加密保护程序密钥。
400 SecurityAzureKeyVaultInvalidKeyName - 由于服务器密钥名称无效，无法完成该作。
400 OldGenerationOfAKVKeyBeingUsedError - 不允许将旧版 AKV 密钥用作 TDE 保护程序。请使用最新版本的 AKV 密钥作为加密保护程序
400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - 未在目标数据库上设置 Per Database CMK 标识。
400 AdalGenericError - 由于遇到 Azure Active Directory 错误，无法完成该作。
400 AdalServicePrincipalNotFound - 无法完成该作，因为遇到 Azure Active Directory 库服务主体找不到错误。
400 AzureKeyVaultMalformedVaultUri - 提供的 Key Vault URI 无效。
400 AttemptedEncryptionOnSystemDatabase - 无法加密系统数据库。不能对“master”、“model”、“tempdb”、“msdb”或“resource”数据库执行数据库加密作。
400 ReadOnly - 无法在只读、具有只读文件或未恢复的数据库上启用或禁用数据库加密。
400 CanNotChangeReadOnlyDuringTdeScan - 在加密转换正在进行时无法修改文件组只读/读写状态。
400 CanNotDropAlterOnMirror - 请修改主数据库上的透明数据加密。
400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作
400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作
409 ServerKeyNameAlreadyExists - 服务器上已存在服务器密钥。
409 ServerKeyUriAlreadyExists - 服务器上已存在服务器密钥 URI。
409 ServerKeyDoesNotExists - 服务器密钥不存在。
409 AzureKeyVaultKeyNameNotFound - 无法完成该作，因为 Azure Key Vault 密钥名称不存在。
409 AzureKeyVaultKeyInUse - 服务器当前正在使用密钥。
409 EncryptionInProgress - 在加密扫描过程中无法修改加密。
409 KeyChangeInProgress - 加密、解密或密钥更改扫描正在进行时无法更改数据库加密密钥。
409 NoBulkOperationLock - CREATE/ALTER/DROP DATABASE ENCRYPTION KEY 失败，因为无法将锁放置在数据库上。请稍后再试。
409 NeedsLogBackup - 请等待几分钟，以便进行日志备份。
409 AltStateConflict - 无法对数据库执行该作，因为它涉及数据库镜像会话或可用性组。不允许对参与数据库镜像会话或可用性组的数据库执行某些作。
503 AzureKeyVaultConnectionFailed - 无法在服务器上完成该作，因为尝试连接到 Azure Key Vault 失败
503 AzureKeyVaultGenericConnectionError - 无法完成该作，因为尝试检索 Key Vault 信息时遇到错误。
503 NoDekLock - CREATE/ALTER/DROP DATABASE ENCRYPTION KEY 失败，因为无法将锁放置在数据库上。请稍后再试。

示例

Get a database's transparent data encryption

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/security-tde-resourcegroup/providers/Microsoft.Sql/servers/securitytde/databases/testdb/transparentDataEncryption/current?api-version=2023-08-01

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/stable/2023-08-01/examples/TransparentDataEncryptionGet.json
// this example is just showing the usage of "TransparentDataEncryptions_Get" 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://free.blessedness.top/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 LogicalDatabaseTransparentDataEncryptionResource created on azure
// for more information of creating LogicalDatabaseTransparentDataEncryptionResource, please refer to the document of LogicalDatabaseTransparentDataEncryptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "security-tde-resourcegroup";
string serverName = "securitytde";
string databaseName = "testdb";
TransparentDataEncryptionName tdeName = TransparentDataEncryptionName.Current;
ResourceIdentifier logicalDatabaseTransparentDataEncryptionResourceId = LogicalDatabaseTransparentDataEncryptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, tdeName);
LogicalDatabaseTransparentDataEncryptionResource logicalDatabaseTransparentDataEncryption = client.GetLogicalDatabaseTransparentDataEncryptionResource(logicalDatabaseTransparentDataEncryptionResourceId);

// invoke the operation
LogicalDatabaseTransparentDataEncryptionResource result = await logicalDatabaseTransparentDataEncryption.GetAsync();

// 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

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

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LogicalDatabaseTransparentDataEncryption	逻辑数据库透明数据加密状态。
TransparentDataEncryptionName	透明数据加密配置的名称。
TransparentDataEncryptionState	指定透明数据加密的状态。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

LogicalDatabaseTransparentDataEncryption

Object

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

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.state	TransparentDataEncryptionState	指定透明数据加密的状态。
type	string	资源类型。

TransparentDataEncryptionName

枚举

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

值	说明
current

TransparentDataEncryptionState

枚举

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

值	说明
Enabled
Disabled

通过

Transparent Data Encryptions - Get

URI 参数

响应

示例

Get a database's transparent data encryption

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogicalDatabaseTransparentDataEncryption

TransparentDataEncryptionName

TransparentDataEncryptionState