Server Keys - Create Or Update

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

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}?api-version=2021-11-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 リソース マネージャー 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'

応答

名前 型 説明
200 OK

ServerKey

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

ServerKey

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

同意
Other Status Codes

エラー応答: ***

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

例

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=2021-11-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": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}
状態コード:
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": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}
状態コード:
202

定義

名前 説明
ServerKey

サーバー キー。
ServerKeyType

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

ServerKey

サーバー キー。

名前 型 説明
id

string

リソースの ID
kind

string

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

string

リソースの場所。
name

string

リソース名。
properties.autoRotationEnabled

boolean

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

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'
type

string

リソースの種類。

ServerKeyType

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

名前 型 説明
AzureKeyVault

string

ServiceManaged

string