Transparent Data Encryptions - Get

Ссылка

Служба:: SQL Database

Версия API:: 2021-11-01

Возвращает прозрачное шифрование данных логической базы данных.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя логической базы данных, для которой определено прозрачное шифрование данных.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
tdeName	path	True	TransparentDataEncryptionName	Имя конфигурации прозрачного шифрования данных.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

Имя	Тип	Описание
200 OK	LogicalDatabaseTransparentDataEncryption	Успешно получено прозрачное шифрование данных логической базы данных.
Other Status Codes		Ответы об ошибках: *** 400 SecurityAdalPrincipalCertExpiredError — не удалось завершить операцию, так как истек срок действия сертификата субъекта Key Vault Azure. 400 AkvHostNotResolvingFromNode — узел AKV "{0}" не разрешается из SQL на сервере "{1}". 400 SecurityInvalidAzureKeyVaultRecoveryLevel — указанный URI Key Vault является недопустимым. 400 KeyMaterialNotFoundOnRemoteServer — удаленный сервер не имеет доступа к материалу ключа, используемому в качестве предохранителя TDE. 400 AzureKeyVaultRsaKeyNotSupported — предоставленное хранилище ключей использует неподдерживаемый размер или тип ключа RSA. Поддерживаемый размер ключа RSA — 2048 или 3072, а тип ключа — RSA или RSA-HSM. 400 AzureKeyVaultKeyDisabled — не удалось выполнить операцию на сервере, так как ключ Key Vault Azure отключен. 400 AzureKeyVaultInvalidExpirationDate — не удалось выполнить операцию, так как недопустимая дата окончания срока действия ключа Key Vault Azure. 400 SameKeyUriNotFoundOnRemoteServer — сервер-получатель не содержит материал ключа из того же хранилища ключей, что и предохранитель шифрования сервера-источника с включенной автоматической сменой ключей. 400 SecurityAzureKeyVaultUrlNullOrEmpty — не удалось выполнить операцию, так как URI Key Vault Azure имеет значение NULL или пуст. 400 SameKeyMaterialNotFoundOnRemoteServer — сервер-получатель не имеет материала ключа предохранителя шифрования основного сервера. 400 PerDatabaseCMKRestoreNotSupported — восстановление базы данных не поддерживается, если cmK уровня базы данных настроен в предварительной версии. 400 AzureKeyVaultNoServerIdentity — удостоверение сервера настроено неправильно. 400 PerDatabaseCMKHSNotSupported — CMK уровня базы данных в предварительной версии не поддерживается для выпуска "Гипермасштабирование". 400 AzureKeyVaultInvalidUri — недопустимый ответ от azure Key Vault. Используйте допустимый URI Key Vault Azure. 400 AzureKeyVaultMissingPermissions — на сервере отсутствуют необходимые разрешения на Key Vault Azure. 400 UmiMissingAkvPermissions — PrimaryUserAssignedId, предоставленный пользователем, не имеет доступа к предоставленному идентификатору KeyId 400 AkvEndpointNotReachableFromNode — конечная точка AKV "{0}" недоступна из SQL на сервере "{1}". 400 SecurityAzureKeyVaultInvalidKeyName — не удалось выполнить операцию из-за недопустимого имени ключа сервера. 400 AdalGenericError — не удалось завершить операцию, так как обнаружена ошибка Azure Active Directory. 400 AdalServicePrincipalNotFound — не удалось выполнить операцию, так как обнаружена ошибка субъект-служба библиотеки Azure Active Directory не найдена. 400 AzureKeyVaultMalformedVaultUri — указанный URI Key Vault является недопустимым. 400 SecurityAzureKeyVaultGeoChainError — создание вторичной базы данных(процесс, называемый цепочкой) не поддерживается при включении прозрачного шифрования данных с помощью Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported — CMK на уровне базы данных в предварительной версии не поддерживается для выпуска Datawarehouse. 400 ReadOnly — не удается включить или изменить шифрование базы данных, которая доступна только для чтения, имеет файлы только для чтения или не восстанавливается. 400 CanNotDropAlterOnMirror — измените прозрачное шифрование данных в базах данных-источниках. 400 AttemptedEncryptionOnSystemDatabase — не удается зашифровать системную базу данных. Операции шифрования нельзя применять к базам данных master, model, tempdb, msdb и resource. 401 CanNotChangeReadOnlyDuringTdeScan — невозможно изменить состояние файловой группы только для чтения и чтения и записи во время перехода шифрования. 409 ServerKeyNameAlreadyExists — ключ сервера уже существует на сервере. 409 ServerKeyUriAlreadyExists — URI ключа сервера уже существует на сервере. 409 ServerKeyDoesNotExists. Ключ сервера не существует. 409 AzureKeyVaultKeyNameNotFound — не удалось выполнить операцию, так как имя ключа Key Vault Azure не существует. 409 AzureKeyVaultKeyInUse — ключ в настоящее время используется сервером. 409 NeedsLogBackup — подождите несколько минут, пока не будет создана резервная копия журнала. 409 EncryptionInProgress — не удается изменить шифрование во время проверки шифрования. 409 KeyChangeInProgress — невозможно изменить ключ шифрования базы данных во время шифрования, расшифровки или проверки изменений ключа. 409 NoBulkOperationLock — сбой CREATE/ALTER/DROP DATABASE ENCRYPTION KEY, так как не удалось заблокировать базу данных. Повторите попытку позже. 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

Ответы об ошибках: ***

400 SecurityAdalPrincipalCertExpiredError — не удалось завершить операцию, так как истек срок действия сертификата субъекта Key Vault Azure.
400 AkvHostNotResolvingFromNode — узел AKV "{0}" не разрешается из SQL на сервере "{1}".
400 SecurityInvalidAzureKeyVaultRecoveryLevel — указанный URI Key Vault является недопустимым.
400 KeyMaterialNotFoundOnRemoteServer — удаленный сервер не имеет доступа к материалу ключа, используемому в качестве предохранителя TDE.
400 AzureKeyVaultRsaKeyNotSupported — предоставленное хранилище ключей использует неподдерживаемый размер или тип ключа RSA. Поддерживаемый размер ключа RSA — 2048 или 3072, а тип ключа — RSA или RSA-HSM.
400 AzureKeyVaultKeyDisabled — не удалось выполнить операцию на сервере, так как ключ Key Vault Azure отключен.
400 AzureKeyVaultInvalidExpirationDate — не удалось выполнить операцию, так как недопустимая дата окончания срока действия ключа Key Vault Azure.
400 SameKeyUriNotFoundOnRemoteServer — сервер-получатель не содержит материал ключа из того же хранилища ключей, что и предохранитель шифрования сервера-источника с включенной автоматической сменой ключей.
400 SecurityAzureKeyVaultUrlNullOrEmpty — не удалось выполнить операцию, так как URI Key Vault Azure имеет значение NULL или пуст.
400 SameKeyMaterialNotFoundOnRemoteServer — сервер-получатель не имеет материала ключа предохранителя шифрования основного сервера.
400 PerDatabaseCMKRestoreNotSupported — восстановление базы данных не поддерживается, если cmK уровня базы данных настроен в предварительной версии.
400 AzureKeyVaultNoServerIdentity — удостоверение сервера настроено неправильно.
400 PerDatabaseCMKHSNotSupported — CMK уровня базы данных в предварительной версии не поддерживается для выпуска "Гипермасштабирование".
400 AzureKeyVaultInvalidUri — недопустимый ответ от azure Key Vault. Используйте допустимый URI Key Vault Azure.
400 AzureKeyVaultMissingPermissions — на сервере отсутствуют необходимые разрешения на Key Vault Azure.
400 UmiMissingAkvPermissions — PrimaryUserAssignedId, предоставленный пользователем, не имеет доступа к предоставленному идентификатору KeyId
400 AkvEndpointNotReachableFromNode — конечная точка AKV "{0}" недоступна из SQL на сервере "{1}".
400 SecurityAzureKeyVaultInvalidKeyName — не удалось выполнить операцию из-за недопустимого имени ключа сервера.
400 AdalGenericError — не удалось завершить операцию, так как обнаружена ошибка Azure Active Directory.
400 AdalServicePrincipalNotFound — не удалось выполнить операцию, так как обнаружена ошибка субъект-служба библиотеки Azure Active Directory не найдена.
400 AzureKeyVaultMalformedVaultUri — указанный URI Key Vault является недопустимым.
400 SecurityAzureKeyVaultGeoChainError — создание вторичной базы данных(процесс, называемый цепочкой) не поддерживается при включении прозрачного шифрования данных с помощью Azure Key Vault (BYOK).
400 PerDatabaseCMKDWNotSupported — CMK на уровне базы данных в предварительной версии не поддерживается для выпуска Datawarehouse.
400 ReadOnly — не удается включить или изменить шифрование базы данных, которая доступна только для чтения, имеет файлы только для чтения или не восстанавливается.
400 CanNotDropAlterOnMirror — измените прозрачное шифрование данных в базах данных-источниках.
400 AttemptedEncryptionOnSystemDatabase — не удается зашифровать системную базу данных. Операции шифрования нельзя применять к базам данных master, model, tempdb, msdb и resource.
401 CanNotChangeReadOnlyDuringTdeScan — невозможно изменить состояние файловой группы только для чтения и чтения и записи во время перехода шифрования.
409 ServerKeyNameAlreadyExists — ключ сервера уже существует на сервере.
409 ServerKeyUriAlreadyExists — URI ключа сервера уже существует на сервере.
409 ServerKeyDoesNotExists. Ключ сервера не существует.
409 AzureKeyVaultKeyNameNotFound — не удалось выполнить операцию, так как имя ключа Key Vault Azure не существует.
409 AzureKeyVaultKeyInUse — ключ в настоящее время используется сервером.
409 NeedsLogBackup — подождите несколько минут, пока не будет создана резервная копия журнала.
409 EncryptionInProgress — не удается изменить шифрование во время проверки шифрования.
409 KeyChangeInProgress — невозможно изменить ключ шифрования базы данных во время шифрования, расшифровки или проверки изменений ключа.
409 NoBulkOperationLock — сбой CREATE/ALTER/DROP DATABASE ENCRYPTION KEY, так как не удалось заблокировать базу данных. Повторите попытку позже.
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=2021-11-01


import com.azure.resourcemanager.sql.models.TransparentDataEncryptionName;

/**
 * Samples for TransparentDataEncryptions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/TransparentDataEncryptionGet.json
     */
    /**
     * Sample code: Get a database's transparent data encryption.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getADatabaseSTransparentDataEncryption(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getTransparentDataEncryptions().getWithResponse(
            "security-tde-resourcegroup", "securitytde", "testdb", TransparentDataEncryptionName.CURRENT,
            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

Пример ответа

Код состояния:: 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"
  }
}

Определения

Имя	Описание
LogicalDatabaseTransparentDataEncryption	Прозрачное состояние шифрования данных логической базы данных.
TransparentDataEncryptionName	Имя конфигурации прозрачного шифрования данных.
TransparentDataEncryptionState	Указывает состояние прозрачного шифрования данных.

LogicalDatabaseTransparentDataEncryption

Прозрачное состояние шифрования данных логической базы данных.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.state	TransparentDataEncryptionState	Указывает состояние прозрачного шифрования данных.
type	string	Тип ресурса.

TransparentDataEncryptionName

Имя конфигурации прозрачного шифрования данных.

Имя	Тип	Описание
current	string

TransparentDataEncryptionState

Указывает состояние прозрачного шифрования данных.

Имя	Тип	Описание
Disabled	string
Enabled	string

Поделиться через

Transparent Data Encryptions - Get

Параметры URI

Ответы

Примеры

Get a database's transparent data encryption

Образец запроса

Пример ответа

Определения

LogicalDatabaseTransparentDataEncryption

TransparentDataEncryptionName

TransparentDataEncryptionState

Дополнительные ресурсы