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	取得するサーバーキーの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前の大文字と小文字は区別されません。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する 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	リソース「ServerKey」更新操作が成功しました
201 Created	ServerKey	リソース「ServerKey」作成操作が成功しましたヘッダー Location: string Retry-After: integer
202 Accepted		リソース操作が受け入れられます。ヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Creates or updates a server key

Creates or updates a server key with versionless key

Creates or updates a server key

要求のサンプル

HTTP

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

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

状態コード:: 201

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

状態コード:: 202

Creates or updates a server key with versionless key

要求のサンプル

HTTP

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

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

状態コード:: 201

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

状態コード:: 202

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ServerKey	サーバーキー。
ServerKeyType	"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

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 (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	暗号化保護機能の種類。これはAzureポータル体験で使用されるメタデータです。
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' の形式である必要があります。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

ServerKeyType

列挙

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

値	説明
ServiceManaged	ServiceManaged
AzureKeyVault	AzureKeyVault

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。