Managed Instance Encryption Protectors - Create Or Update

既存の暗号化保護機能を更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/current?api-version=2020-08-01-preview

URI パラメーター

Name In Required Type Description
encryptionProtectorName
path True

更新する暗号化保護機能の名前。

managedInstanceName
path True
  • string

マネージド インスタンスの名前。

resourceGroupName
path True
  • string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

要求本文

Name Required Type Description
properties.serverKeyType True

"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。

properties.autoRotationEnabled
  • boolean

キー自動ローテーションオプトイン フラグ。 true または false。

properties.serverKeyName
  • string

マネージド インスタンス キーの名前。

応答

Name Type Description
200 OK

暗号化保護機能が正常に更新されました。

202 Accepted

承認済み

Other Status Codes

エラー応答: ***

  • 400 InvalidKeyName - サーバー キー名に無効な値が指定されました。

  • 400 InvalidKeyType - サーバー キーの作成の種類はサポートされていません。

  • 400 InvalidUpsertKeyType - サービスで管理される TDE キーは、サービスによって管理されます。 サービスで管理される TDE キーは、ユーザーによる作成または更新をサポートしていません。

  • 400 InvalidKeyUpsertRequest - サーバー キーの作成要求が存在しないか、プロパティ オブジェクトがありません。

  • 400 InvalidEncryptionProtectorName - 暗号化保護機能キー名はサポートされていません。

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

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

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

  • 400 AzureKeyVaultMismatchError - http 応答で予期しないKey Vaultリージョンが見つかりました。

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

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

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

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

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

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

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

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

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

  • "401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. " (401 AzureKeyVaultMissingPermissions - サーバーには Azure Key Vault に必要なアクセス許可がありません。)

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

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

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたリソース グループとサブスクリプションに指定されたサーバーが存在しません。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

  • "404 ServerKeyNotFound - The requested server key was not found on the current subscription. " (404 ServerKeyNotFound - 要求されたサーバー キーは、現在のサブスクリプションで使用できません。)

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

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

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

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

  • 409 AzureKeyVaultKeyInUse - キーは現在サーバーによって使用されています。

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

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

Update the encryption protector to key vault
Update the encryption protector to service managed

Update the encryption protector to key vault

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2020-08-01-preview

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "autoRotationEnabled": false
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false
  }
}

Update the encryption protector to service managed

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2020-08-01-preview

{
  "properties": {
    "serverKeyType": "ServiceManaged",
    "serverKeyName": "ServiceManaged"
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "servicemanaged",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

定義

EncryptionProtectorName

更新する暗号化保護機能の名前。

ManagedInstanceEncryptionProtector

マネージド インスタンス暗号化保護機能。

ServerKeyType

"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。

EncryptionProtectorName

更新する暗号化保護機能の名前。

Name Type Description
current
  • string

ManagedInstanceEncryptionProtector

マネージド インスタンス暗号化保護機能。

Name Type Description
id
  • string

リソースの ID

kind
  • string

暗号化保護機能の種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。

name
  • string

リソース名。

properties.autoRotationEnabled
  • boolean

キー自動ローテーションオプトイン フラグ。 true または false。

properties.serverKeyName
  • string

マネージド インスタンス キーの名前。

properties.serverKeyType

"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。

properties.thumbprint
  • string

サーバー キーの拇印。

properties.uri
  • string

サーバー キーの URI。

type
  • string

リソースの種類。

ServerKeyType

"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string