次の方法で共有

Server Keys - Create Or Update

サービス:
SQL Database
API バージョン:
2025-01-01

サーバー キーを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}?api-version=2025-01-01

URI パラメーター

名前 / 必須 型 説明
keyName
 path True

string

操作する (更新または作成される) サーバー キーの名前。 キー名は、'vault_key_version' の形式である必要があります。 たとえば、keyId が https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersionされている場合、サーバー キー名は次のように書式設定する必要があります: YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName
 path True

string

リソースを含むリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
serverName
 path True

string

サーバーの名前。
subscriptionId
 path True

string

Azure サブスクリプションを識別するサブスクリプション ID。
api-version
 query True

string

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

要求本文

名前 必須 型 説明
properties.serverKeyType True

ServerKeyType

"ServiceManaged"、"AzureKeyVault" などのサーバー キーの種類。
properties.uri

string

サーバー キーの URI。 ServerKeyType が AzureKeyVault の場合は、URI が必要です。 AKV URI は、'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' または 'https://YourVaultName.vault.azure.net/keys/YourKeyName' の形式である必要があります。

応答

名前 型 説明
200 OK

ServerKey

サーバー キーが正常に更新されました。
201 Created

ServerKey

サーバー キーが正常に作成されました。
202 Accepted

承認済み

ヘッダー

Location: string
Other Status Codes

ErrorResponse

エラー応答: ***

  • 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合

  • 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合

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

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

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

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

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

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

  • 400 AkvKeyDisabled - カスタマー マネージド キーに対する操作は、Azure Key Vault では許可されていません。 キーに対して次の操作を許可してください: "get"、"wrapKey"、"unwrapKey"。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 400 AkvKeyOperationNotAllowed - カスタマー マネージド キーに対する操作は、Azure Key Vault では許可されません。 キーに対して次の操作を許可してください: "get"、"wrapKey"、"unwrapKey"。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 400 AkvKeyOperationNotAllowedByRBAC - カスタマー マネージド キーに対する必要な操作の 1 つは、Azure Key Vault のマネージド インスタンス ID の現在選択されている RBAC ロールでは許可されません。 キー コンテナーに対するアクセス許可を許可する RBAC ロールに変更してください: "get"、"wrapKey"、"unwrapKey"。 この問題の解決については、次を参照してください。 https://aka.ms/sqlmi-tde-troubleshooting

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

  • 400 AkvKeyOperationNotAllowedByFirewall - Azure Key Vault ファイアウォール ポリシーによって Azure Key Vault への接続が禁止されました。 Azure Key Vault ファイアウォール ポリシーを確認して、Managed Instance からの接続を有効にしてください。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 400 AkvKeyAccessDenied - Azure Key Vault のカスタマー マネージド キーに対する必要な操作の 1 つは、マネージド インスタンス ID によって使用されている現在設定されているキー コンテナー ポリシーでは許可されていません。 キー コンテナーで次のアクセス許可を許可するポリシーを使用してください: "get"、"wrapKey"、"unwrapKey"。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 400 AkvKeyAccessGeneral403 - Managed Instance によって要求された Azure Key Vault 操作は、アクセス許可が不十分なために失敗しました。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 400 MissingKeyVaultUriForRestore - Azure Key Vault キー URI '{0}' は、サーバー '{1}' の下にあるデータベース '{2}' を正常に復元するために必要です。

  • 400 AkvKeyDeleted - カスタマー マネージド キーが Azure Key Vault で見つかりませんでした最近削除された場合、キー コンテナーで "論理的な削除" 保護が有効になっている場合、回復できる可能性があります。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 400 AkvKeyTimeout - Azure Key Vault への接続を確立できませんでした。 マネージド インスタンス '%s' のネットワーク設定を確認してください。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 400 AzureKeyVaultKeyUsedOnGeoPrimary - Azure Key Vault キー名 {0} が現在 geo プライマリの暗号化保護機能として設定されているため、操作を完了できませんでした。

  • 400 AkvKeyDNS - Azure Key Vault URI を解決できませんでした。 キー コンテナー URI が有効であること、および Managed Instance のネットワーク設定で Azure パブリック DNS へのアクセスがブロックされていないことを確認してください。 この問題の解決については、 https://aka.ms/sqlmi-tde-troubleshootingを参照してください。

  • 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 - 対応するアクセス不能の根本原因が軽減されていないため、SQL Managed Instance 上の 1 つ以上のデータベースにアクセスできません。 現在アクセスできないすべてのデータベースのアクセス不能の根本原因を軽減し、操作を再試行してください。

  • 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 が無効です。

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

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

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

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

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

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

  • 409 ServerKeyDoesNotExists - サーバー キーが存在しません。

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

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

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

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

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

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

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

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

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

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

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

例

Creates or updates a server key
Creates or updates a server key with versionless key

Creates or updates a server key

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901?api-version=2025-01-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2024-11-15T00:00:00Z"
  }
}
状態コード:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2024-11-15T00:00:00Z"
  }
}
状態コード:
202

Creates or updates a server key with versionless key

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey?api-version=2025-01-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2024-11-15T00:00:00Z"
  }
}
状態コード:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2024-11-15T00:00:00Z"
  }
}
状態コード:
202

定義

名前 説明
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
ServerKey

サーバー キー。
ServerKeyType

"ServiceManaged"、"AzureKeyVault" などのサーバー キーの種類。

ErrorAdditionalInfo

Object

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

ServerKey

Object

サーバー キー。

名前 型 説明
id

string

リソース ID。
kind

string

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

string

リソースの場所。
name

string

リソース名。
properties.autoRotationEnabled

boolean

キー自動ローテーションオプトイン フラグ。 true または false のいずれか。
properties.creationDate

string (date-time)

サーバー キーの作成日。
properties.keyVersion

string

サーバー キーのバージョン。
properties.serverKeyType

ServerKeyType

"ServiceManaged"、"AzureKeyVault" などのサーバー キーの種類。
properties.subregion

string

サーバー キーのサブ領域。
properties.thumbprint

string

サーバー キーの拇印。
properties.uri

string

サーバー キーの URI。 ServerKeyType が AzureKeyVault の場合は、URI が必要です。 AKV URI は、'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' または 'https://YourVaultName.vault.azure.net/keys/YourKeyName' の形式である必要があります。
type

string

リソースの種類。

ServerKeyType

列挙

"ServiceManaged"、"AzureKeyVault" などのサーバー キーの種類。

値 説明
ServiceManaged
AzureKeyVault