Encryption Protectors - Create Or Update
既存の暗号化保護機能を更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/current?api-version=2023-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
encryption
|
path | True |
更新する暗号化保護機能の名前。 |
|
resource
|
path | True |
string |
リソースを含むリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。 |
server
|
path | True |
string |
サーバーの名前。 |
subscription
|
path | True |
string |
Azure サブスクリプションを識別するサブスクリプション ID。 |
api-version
|
query | True |
string |
要求に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.serverKeyType | True |
"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。 |
|
properties.autoRotationEnabled |
boolean |
キー自動ローテーションオプトイン フラグ。 true または false のいずれか。 |
|
properties.serverKeyName |
string |
サーバー キーの名前。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
暗号化保護機能が正常に更新されました。 |
|
202 Accepted |
受け入れ られる ヘッダー Location: string |
|
Other Status Codes |
エラー応答: ***
|
例
Update the encryption protector to key vault |
Update the encryption protector to service managed |
Update the encryption protector to key vault
要求のサンプル
PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2023-08-01
{
"properties": {
"serverKeyType": "AzureKeyVault",
"serverKeyName": "someVault_someKey_01234567890123456789012345678901",
"autoRotationEnabled": false
}
}
応答のサンプル
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
"name": "current",
"type": "Microsoft.Sql/servers/encryptionProtector",
"location": "West US",
"kind": "azurekeyvault",
"properties": {
"serverKeyName": "someVault_someKey_01234567890123456789012345678901",
"serverKeyType": "AzureKeyVault",
"autoRotationEnabled": false
}
}
Update the encryption protector to service managed
要求のサンプル
PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2023-08-01
{
"properties": {
"serverKeyType": "ServiceManaged",
"serverKeyName": "ServiceManaged"
}
}
応答のサンプル
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
"name": "current",
"type": "Microsoft.Sql/servers/encryptionProtector",
"location": "West US",
"kind": "servicemanaged",
"properties": {
"serverKeyName": "ServiceManaged",
"serverKeyType": "ServiceManaged"
}
}
定義
名前 | 説明 |
---|---|
Encryption |
サーバー暗号化保護機能。 |
Encryption |
更新する暗号化保護機能の名前。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Server |
"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。 |
EncryptionProtector
サーバー暗号化保護機能。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソース ID。 |
kind |
string |
暗号化保護機能の種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。 |
location |
string |
リソースの場所。 |
name |
string |
リソース名。 |
properties.autoRotationEnabled |
boolean |
キー自動ローテーションオプトイン フラグ。 true または false のいずれか。 |
properties.serverKeyName |
string |
サーバー キーの名前。 |
properties.serverKeyType |
"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。 |
|
properties.subregion |
string |
暗号化保護機能のサブ領域。 |
properties.thumbprint |
string |
サーバー キーの拇印。 |
properties.uri |
string |
サーバー キーの URI。 |
type |
string |
リソースの種類。 |
EncryptionProtectorName
更新する暗号化保護機能の名前。
値 | 説明 |
---|---|
current |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
ServerKeyType
"ServiceManaged"、"AzureKeyVault" などの暗号化保護機能の種類。
値 | 説明 |
---|---|
AzureKeyVault | |
ServiceManaged |