Transparent Data Encryptions - Create Or Update

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

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

PUT 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

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー 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

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

エラー応答: ***

  • 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault プリンシパル証明書の有効期限が切れているため、操作を完了できませんでした。

  • 400 AkvHostNotResolvingFromNode - AKV ホスト '' は、サーバー '{0}{1}' の SQL から解決できません。

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 指定されたKey Vault URI が無効です。

  • 400 KeyMaterialNotFoundOnRemoteServer - リモート サーバーは、TDE 保護機能として使用されるキー マテリアルにアクセスできません。

  • 400 AzureKeyVaultRsaKeyNotSupported - 提供されたキー コンテナーでは、サポートされていない RSA キー サイズまたはキーの種類が使用されます。 サポートされている RSA キー サイズは 2048 または 3072 で、キーの種類は RSA または RSA-HSM です。

  • 400 AzureKeyVaultKeyDisabled - Azure Key Vault キーが無効になっているため、サーバーで操作を完了できませんでした。

  • 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault キーの有効期限が無効であるため、操作を完了できませんでした。

  • 400 SameKeyUriNotFoundOnRemoteServer - セカンダリ サーバーには、キーの自動ローテーションが有効になっているプライマリ サーバーの暗号化保護機能と同じキー コンテナーのキー マテリアルがありません。

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault Uri が null または空であるため、操作を完了できませんでした。

  • 400 SameKeyMaterialNotFoundOnRemoteServer - セカンダリ サーバーには、プライマリ サーバーの暗号化保護機能のキー マテリアルがありません。

  • 400 PerDatabaseCMKRestoreNotSupported - データベース レベルの CMK がプレビューで構成されている場合、データベースの復元はサポートされません。

  • 400 AzureKeyVaultNoServerIdentity - サーバー ID が正しく構成されていません。

  • 400 PerDatabaseCMKHSNotSupported - プレビュー段階のデータベースレベルの CMK は、Hyperscale エディションではサポートされていません。

  • 400 AzureKeyVaultInvalidUri - Azure Key Vault からの無効な応答。 有効な Azure Key Vault URI を使用してください。

  • 400 AzureKeyVaultMissingPermissions - サーバーに Azure Key Vaultに必要なアクセス許可がありません。

  • 400 UmiMissingAkvPermissions - ユーザーが提供する PrimaryUserAssignedIdentityId は、指定された KeyId にアクセスできません

  • 400 AkvEndpointNotReachableFromNode - サーバー '' の SQL から AKV エンドポイント '{0}{1}' に到達できません。

  • 400 SecurityAzureKeyVaultInvalidKeyName - サーバー キー名が無効なため、操作を完了できませんでした。

  • 400 AdalGenericError - Azure Active Directory エラーが発生したため、操作を完了できませんでした。

  • 400 AdalServicePrincipalNotFound - Azure Active Directory ライブラリのサービス プリンシパルが見つからないというエラーが発生したため、操作を完了できませんでした。

  • 400 AzureKeyVaultMalformedVaultUri - 指定されたKey Vault URI が無効です。

  • 400 SecurityAzureKeyVaultGeoChainError - Azure Key Vault (BYOK) を使用して Transparent Data Encryption を有効にする場合、セカンダリのセカンダリ (チェーンと呼ばれるプロセス) の作成はサポートされません。

  • 400 PerDatabaseCMKDWNotSupported - Datawarehouse エディションでは、プレビュー段階のデータベースレベルの CMK はサポートされていません。

  • 400 ReadOnly - 読み取り専用、読み取り専用ファイル、または復旧されていないデータベースのデータベース暗号化を有効または変更できません。

  • 400 CanNotDropAlterOnMirror - プライマリ データベースの Transparent Data Encryption を変更してください。

  • 400 AttemptedEncryptionOnSystemDatabase - システム データベースを暗号化できません。 データベースの暗号化操作は、'master'、'model'、'tempdb'、'msdb'、または 'resource' の各データベースに対して実行できません。

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

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

  • 401 CanNotChangeReadOnlyDuringTdeScan - 暗号化移行の進行中にファイル グループの読み取り専用/読み取り/書き込み状態を変更できません。

  • 409 ServerKeyNameAlreadyExists - サーバー キーは既にサーバーに存在します。

  • 409 ServerKeyUriAlreadyExists - サーバー キー URI はサーバー上に既に存在します。

  • "409 ServerKeyDoesNotExists - The server key does not exist. " (409 ServerKeyDoesNotExists - サーバー キーは存在しません。)

  • 409 AzureKeyVaultKeyNameNotFound - Azure Key Vault キー名が存在しないため、操作を完了できませんでした。

  • 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 が失敗しました。 後で再試行してください。

例

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=2021-11-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

定義

名前 説明
LogicalDatabaseTransparentDataEncryption

論理データベースの透過的なデータ暗号化の状態。
TransparentDataEncryptionName

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

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

LogicalDatabaseTransparentDataEncryption

論理データベースの透過的なデータ暗号化の状態。

名前 型 説明
id

string

リソースの ID
name

string

リソース名。
properties.state

TransparentDataEncryptionState

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

string

リソースの種類。

TransparentDataEncryptionName

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

名前 型 説明
current

string

TransparentDataEncryptionState

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

名前 型 説明
Disabled

string

Enabled

string