Managed Database Transparent Data Encryption - Get

サービス:: SQL Database

API バージョン:: 2023-08-01

マネージドデータベースの透過的なデータ暗号化を取得します。

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

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	透過的なデータ暗号化が定義されているマネージドデータベースの名前。
managedInstanceName	path	True	string	マネージドインスタンスの名前。
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
tdeName	path	True	TransparentDataEncryptionName	透過的なデータ暗号化構成の名前。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	ManagedTransparentDataEncryption	マネージドデータベースの透過的なデータ暗号化を正常に取得しました。
Other Status Codes	ErrorResponse	エラー応答: *** 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault プリンシパル証明書の有効期限が切れているため、操作を完了できませんでした。 400 AkvHostNotResolvingFromNode - AKV host '{0}' は SQL から解決できません。サーバー '{1}'。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 指定された Key Vault URI が無効です。 400 MissingKeyVaultUriForRestore - Azure Key Vault キー URI '{0}' は、サーバー '{1}' の下にあるデータベース '{2}' を正常に復元するために必要です。 400 AzureKeyVaultKeyUsedOnGeoPrimary - Azure Key Vault キー名 {0} が現在 geo プライマリの暗号化保護機能として設定されているため、操作を完了できませんでした。 400 KeyMaterialNotFoundOnRemoteServer - リモートサーバーは、TDE 保護機能として使用されるキーマテリアルにアクセスできません。 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary - geo レプリケーション内のすべてのデータベースに、ソースデータベースの暗号化保護機能と同じキーマテリアルが含まれている必要があります。ターゲットデータベース '{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) を使用して Transparent Data Encryption を有効にする場合、セカンダリのセカンダリ (チェーンと呼ばれるプロセス) の作成はサポートされていません。 400 PerDatabaseCMKDWNotSupported - Datawarehouse エディションでは、プレビュー段階のデータベースレベルの CMK はサポートされていません。 400 BlockSystemAssignedIdentityForCrossTenantCMK - クロステナント CMK は、サーバーがユーザー割り当てマネージド ID で構成されている場合にのみ構成できます。ユーザー割り当てマネージド ID を構成するには、https://aka.ms/sqltdebyokumi を参照してください。 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - データベースレベルの暗号化保護機能を使用して構成されたデータベースをレプリケートしようとすると、プライマリで使用されている現在のキーをセカンダリデータベースに渡す必要があります。 400 CannotDropDatabaseAKVError - サーバー {0} 上のデータベース {1} は、削除前に最後のバックアップを取得するためにアクセスできなくなったカスタマーマネージドキーで暗号化されているため、安全に削除できません。サーバーで Azure Key Vault Access を復元し、このデータベースにアクセスできるようにキーを再検証してから、ドロップを続行してください。詳細については、https://aka.ms/tdecmkrestorability を参照してください。 400 CreateDatabaseAttemptedWithRotationInProgress - サーバー上で透過的なデータ暗号化 (TDE) キーのローテーションが進行中のため、現時点ではデータベースの作成操作を実行できません。後でもう一度操作を試してください。 400 AzureKeyVaultKeyDisabled - Azure Key Vault キーが無効になっているため、サーバーで操作を完了できませんでした。 400 PerDatabaseCMKRestoreNotSupported - データベースレベルの CMK がプレビューで構成されている場合、データベースの復元はサポートされません。 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault キーの有効期限が無効であるため、操作を完了できませんでした。 400 PerDatabaseCMKHSNotSupported - プレビュー段階のデータベースレベルの CMK は、Hyperscale エディションではサポートされていません。 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault URI が null または空であるため、操作を完了できませんでした。 400 CMKOperationNotAllowed - サーバーに Azure Key Vault アクセスがない場合に、ユーザーがサーバーで操作を実行しようとしました。 400 AkvEndpointNotReachableFromNode - AKV エンドポイント '{0}' は、サーバー '{1}' 上の SQL から到達できません。 400 AzureKeyVaultNoServerIdentity - サーバー ID が正しく構成されていません。 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 - ターゲットデータベースでデータベースごとの CMK ID が設定されていません。 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 - プライマリデータベースの Transparent Data Encryption を変更してください。 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

ManagedTransparentDataEncryption

マネージドデータベースの透過的なデータ暗号化を正常に取得しました。

Other Status Codes

ErrorResponse

エラー応答: ***

400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault プリンシパル証明書の有効期限が切れているため、操作を完了できませんでした。
400 AkvHostNotResolvingFromNode - AKV host '{0}' は SQL から解決できません。サーバー '{1}'。
400 SecurityInvalidAzureKeyVaultRecoveryLevel - 指定された Key Vault URI が無効です。
400 MissingKeyVaultUriForRestore - Azure Key Vault キー URI '{0}' は、サーバー '{1}' の下にあるデータベース '{2}' を正常に復元するために必要です。
400 AzureKeyVaultKeyUsedOnGeoPrimary - Azure Key Vault キー名 {0} が現在 geo プライマリの暗号化保護機能として設定されているため、操作を完了できませんでした。
400 KeyMaterialNotFoundOnRemoteServer - リモートサーバーは、TDE 保護機能として使用されるキーマテリアルにアクセスできません。
400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary - geo レプリケーション内のすべてのデータベースに、ソースデータベースの暗号化保護機能と同じキーマテリアルが含まれている必要があります。ターゲットデータベース '{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) を使用して Transparent Data Encryption を有効にする場合、セカンダリのセカンダリ (チェーンと呼ばれるプロセス) の作成はサポートされていません。
400 PerDatabaseCMKDWNotSupported - Datawarehouse エディションでは、プレビュー段階のデータベースレベルの CMK はサポートされていません。
400 BlockSystemAssignedIdentityForCrossTenantCMK - クロステナント CMK は、サーバーがユーザー割り当てマネージド ID で構成されている場合にのみ構成できます。ユーザー割り当てマネージド ID を構成するには、https://aka.ms/sqltdebyokumi を参照してください。
400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - データベースレベルの暗号化保護機能を使用して構成されたデータベースをレプリケートしようとすると、プライマリで使用されている現在のキーをセカンダリデータベースに渡す必要があります。
400 CannotDropDatabaseAKVError - サーバー {0} 上のデータベース {1} は、削除前に最後のバックアップを取得するためにアクセスできなくなったカスタマーマネージドキーで暗号化されているため、安全に削除できません。サーバーで Azure Key Vault Access を復元し、このデータベースにアクセスできるようにキーを再検証してから、ドロップを続行してください。詳細については、https://aka.ms/tdecmkrestorability を参照してください。
400 CreateDatabaseAttemptedWithRotationInProgress - サーバー上で透過的なデータ暗号化 (TDE) キーのローテーションが進行中のため、現時点ではデータベースの作成操作を実行できません。後でもう一度操作を試してください。
400 AzureKeyVaultKeyDisabled - Azure Key Vault キーが無効になっているため、サーバーで操作を完了できませんでした。
400 PerDatabaseCMKRestoreNotSupported - データベースレベルの CMK がプレビューで構成されている場合、データベースの復元はサポートされません。
400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault キーの有効期限が無効であるため、操作を完了できませんでした。
400 PerDatabaseCMKHSNotSupported - プレビュー段階のデータベースレベルの CMK は、Hyperscale エディションではサポートされていません。
400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault URI が null または空であるため、操作を完了できませんでした。
400 CMKOperationNotAllowed - サーバーに Azure Key Vault アクセスがない場合に、ユーザーがサーバーで操作を実行しようとしました。
400 AkvEndpointNotReachableFromNode - AKV エンドポイント '{0}' は、サーバー '{1}' 上の SQL から到達できません。
400 AzureKeyVaultNoServerIdentity - サーバー ID が正しく構成されていません。
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 - ターゲットデータベースでデータベースごとの CMK ID が設定されていません。
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 - プライマリデータベースの Transparent Data Encryption を変更してください。
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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ManagedTransparentDataEncryption	マネージドデータベースの透過的なデータ暗号化状態。
TransparentDataEncryptionName	透過的なデータ暗号化構成の名前。
TransparentDataEncryptionState	透過的なデータ暗号化の状態を指定します。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ManagedTransparentDataEncryption

Object

マネージドデータベースの透過的なデータ暗号化状態。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.state	TransparentDataEncryptionState	透過的なデータ暗号化の状態を指定します。
type	string	リソースの種類。

TransparentDataEncryptionName

列挙

透過的なデータ暗号化構成の名前。

値	説明
current

TransparentDataEncryptionState

列挙

透過的なデータ暗号化の状態を指定します。

値	説明
Enabled
Disabled