次の方法で共有

Transparent Data Encryptions - Create Or Update

  • リファレンス
サービス:
SQL Database
API バージョン:
2023-08-01

論理データベースの透過的なデータ暗号化構成を更新します。

PUT 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 Resource Manager API またはポータルから取得できます。
serverName
 path True

string

サーバーの名前。
subscriptionId
 path True

string

Azure サブスクリプションを識別するサブスクリプション ID。
tdeName
 path True

TransparentDataEncryptionName

透過的なデータ暗号化構成の名前。
api-version
 query True

string

要求に使用する API バージョン。

要求本文

名前 必須 型 説明
properties.state True

TransparentDataEncryptionState

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

応答

名前 型 説明
200 OK

LogicalDatabaseTransparentDataEncryption

Transparent Data Encryption のデータベースの状態が正常に更新されました。
201 Created

LogicalDatabaseTransparentDataEncryption

データベースの透過的なデータ暗号化状態が正常に作成されました。
202 Accepted

データベース透過的なデータ暗号化構成の作成または更新が進行中です。

ヘッダー

Location: string
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 - インスタンスが開始状態の間に送信された操作の競合

  • 400 InvalidTransparentDataEncryptionUpdateRequest - 有効な状態を入力してください。 「有効」または「無効」を使用してください。

  • 400 InvalidTransparentDataEncryptionName - 透過的なデータ暗号化キー名はサポートされていません。

  • 404 OperationIdNotFound - Id を持つ操作が存在しません。

  • 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 - データベース ミラーリング セッションまたは可用性グループに関係するため、データベースに対して操作を実行できません。 一部の操作は、データベース ミラーリング セッションまたは可用性グループに参加しているデータベースでは許可されません。

  • 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。

  • 409 OperationCancelled - 操作がユーザーによって取り消されました。

  • 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。

  • 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。 操作を再試行してください。

  • 503 AzureKeyVaultConnectionFailed - Azure Key Vault への接続が失敗したため、サーバーで操作を完了できませんでした

  • 503 AzureKeyVaultGenericConnectionError - Key Vault 情報を取得しようとしたときにエラーが発生したため、操作を完了できませんでした。

  • 503 NoDekLock - データベースにロックを設定できなかったため、CREATE/ALTER/DROP DATABASE ENCRYPTION KEY が失敗しました。 後でもう一度やり直してください。

  • 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

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

要求のサンプル

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=2023-08-01

{
  "properties": {
    "state": "Enabled"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/servers/securitytde-42/databases/testdb/transparentDataEncryption",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/transparentDataEncryption",
  "properties": {
    "state": "Enabled"
  }
}
状態コード:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/servers/securitytde-42/databases/testdb/transparentDataEncryption",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/transparentDataEncryption",
  "properties": {
    "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

定義

名前 説明
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

列挙

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

値 説明
Disabled
Enabled