Skip to content

Commit 6de2c3d

Browse files
author
Rui Zhan
committed
doc
1 parent 8e92932 commit 6de2c3d

3 files changed

Lines changed: 15 additions & 6 deletions

File tree

specification/compute/resource-manager/Microsoft.Compute/Compute/ComputeDisk/Snapshot.tsp

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,10 @@ interface Snapshots {
139139
>;
140140

141141
/**
142-
* Locks the immutability policy of a snapshot. Once locked, the policy cannot be reduced or removed until the lock period expires.
142+
* Locks or updates the immutability policy of a snapshot. This action requires elevated roles such as 'Owner' or 'Administrator'.
143+
* When type is set to 'Locked', the policy is locked and the immutability duration cannot be reduced until expiry.
144+
* When type is set to 'Unlocked', the policy is set or updated as an unlocked policy — this is functionally equivalent to calling
145+
* updateImmutabilityPolicy, but requires elevated privileges. This action has all the privileges of updateImmutabilityPolicy.
143146
*/
144147
@added(Versions.v2026_03_02)
145148
@action("updateImmutabilityPolicyLock")

specification/compute/resource-manager/Microsoft.Compute/Compute/ComputeDisk/models.tsp

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1174,7 +1174,10 @@ model ImmutabilityPolicyData {
11741174
}
11751175

11761176
/**
1177-
* Data used for locking the immutability policy of a snapshot.
1177+
* Data used for locking the immutability policy of a snapshot. This action has elevated privileges and can both lock and unlock policies.
1178+
* When type is set to 'Locked', the policy is locked and cannot be reduced until expiry. When type is set to 'Unlocked', the policy is
1179+
* set or updated as an unlocked policy, equivalent to calling updateImmutabilityPolicy. This action requires elevated roles such as
1180+
* 'Owner' or 'Administrator' regardless of the type value.
11781181
*/
11791182
@added(Versions.v2026_03_02)
11801183
model ImmutabilityPolicyLockData {
@@ -1185,7 +1188,10 @@ model ImmutabilityPolicyLockData {
11851188
immutabilityDurationDays: int32;
11861189

11871190
/**
1188-
* The type of the immutability policy. 'Unlocked' allows the policy to be modified by privileged users; 'Locked' prevents reduction of the immutability duration but allows extension of the lock period.
1191+
* The type of the immutability policy to apply. When set to 'Locked', the policy is locked and the immutability duration cannot be
1192+
* reduced (only extended). When set to 'Unlocked', the policy is set or updated as an unlocked policy — this is functionally equivalent
1193+
* to calling updateImmutabilityPolicy but requires the elevated privileges of the lock action. Both values are accepted because
1194+
* updateImmutabilityPolicyLock has all the privileges of updateImmutabilityPolicy.
11891195
*/
11901196
type: ImmutabilityPolicyType;
11911197
}

specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2026-03-02/DiskRP.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2561,7 +2561,7 @@
25612561
"tags": [
25622562
"Snapshots"
25632563
],
2564-
"description": "Locks the immutability policy of a snapshot. Once locked, the policy cannot be reduced or removed until the lock period expires.",
2564+
"description": "Locks or updates the immutability policy of a snapshot. This action requires elevated roles such as 'Owner' or 'Administrator'.\nWhen type is set to 'Locked', the policy is locked and the immutability duration cannot be reduced until expiry.\nWhen type is set to 'Unlocked', the policy is set or updated as an unlocked policy — this is functionally equivalent to calling\nupdateImmutabilityPolicy, but requires elevated privileges. This action has all the privileges of updateImmutabilityPolicy.",
25652565
"parameters": [
25662566
{
25672567
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
@@ -4281,7 +4281,7 @@
42814281
},
42824282
"ImmutabilityPolicyLockData": {
42834283
"type": "object",
4284-
"description": "Data used for locking the immutability policy of a snapshot.",
4284+
"description": "Data used for locking the immutability policy of a snapshot. This action has elevated privileges and can both lock and unlock policies.\nWhen type is set to 'Locked', the policy is locked and cannot be reduced until expiry. When type is set to 'Unlocked', the policy is\nset or updated as an unlocked policy, equivalent to calling updateImmutabilityPolicy. This action requires elevated roles such as\n'Owner' or 'Administrator' regardless of the type value.",
42854285
"properties": {
42864286
"immutabilityDurationDays": {
42874287
"type": "integer",
@@ -4291,7 +4291,7 @@
42914291
},
42924292
"type": {
42934293
"$ref": "#/definitions/ImmutabilityPolicyType",
4294-
"description": "The type of the immutability policy. 'Unlocked' allows the policy to be modified by privileged users; 'Locked' prevents reduction of the immutability duration but allows extension of the lock period."
4294+
"description": "The type of the immutability policy to apply. When set to 'Locked', the policy is locked and the immutability duration cannot be\nreduced (only extended). When set to 'Unlocked', the policy is set or updated as an unlocked policy — this is functionally equivalent\nto calling updateImmutabilityPolicy but requires the elevated privileges of the lock action. Both values are accepted because\nupdateImmutabilityPolicyLock has all the privileges of updateImmutabilityPolicy."
42954295
}
42964296
},
42974297
"required": [

0 commit comments

Comments
 (0)