You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/Compute/Compute/ChangeLog.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,7 @@
21
21
-->
22
22
## Upcoming Release
23
23
* Added `ConsistencyMode` parameter to `New-AzRestorePoint`
24
+
* Filled in missing parameter descriptions across multiple parameters and improved some existing parameter descriptions.
24
25
25
26
## Version 5.3.0
26
27
* Removed the image `Win2008R2SP1` from the list of available images and documentation. This image is no longer available on the backend so the client tools need to sync to that change.
HelpMessage="ARM id of the DiskAccess resource for using private endpoints on disks")]
78
80
publicstringDiskAccessId{get;set;}
79
81
80
82
[Parameter(
@@ -108,18 +110,19 @@ public partial class NewAzureRmDiskUpdateConfigCommand : Microsoft.Azure.Command
108
110
[Parameter(
109
111
Mandatory=false,
110
112
ValueFromPipelineByPropertyName=true,
111
-
HelpMessage="Sets the Purchase Plan for the Disk")]
113
+
HelpMessage="Sets the purchase plan for the disk. Used for establishing the purchase context of any 3rd Party artifact through Marketplace.")]
112
114
publicPSPurchasePlanPurchasePlan{get;set;}
113
115
114
116
[Parameter(
115
117
Mandatory=false,
116
118
ValueFromPipelineByPropertyName=true,
117
-
HelpMessage="Specify if Disk Supports Hibernation with $true of $false")]
119
+
HelpMessage="Indicates if the OS on the disk supports hibernation with $true or $false")]
118
120
publicbool?SupportsHibernation{get;set;}
119
121
120
122
[Parameter(
121
123
Mandatory=false,
122
-
ValueFromPipelineByPropertyName=true)]
124
+
ValueFromPipelineByPropertyName=true,
125
+
HelpMessage="Enable encryption settings on the disk")]
123
126
publicbool?EncryptionSettingsEnabled{get;set;}
124
127
125
128
[Parameter(
@@ -138,7 +141,8 @@ public partial class NewAzureRmDiskUpdateConfigCommand : Microsoft.Azure.Command
138
141
139
142
[Parameter(
140
143
Mandatory=false,
141
-
ValueFromPipelineByPropertyName=true)]
144
+
ValueFromPipelineByPropertyName=true,
145
+
HelpMessage="The type of key used to encrypt the data of the disk. Available values are: EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerKey")]
Copy file name to clipboardExpand all lines: src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotConfigCommand.cs
+2-3Lines changed: 2 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,6 @@ public partial class NewAzureRmSnapshotConfigCommand : Microsoft.Azure.Commands.
88
88
Mandatory=false,
89
89
ValueFromPipelineByPropertyName=true,
90
90
HelpMessage="Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. Possible values are: Empty, Attach, FromImage, Import, Copy, Restore, Upload, CopyStart")]
91
-
//todo: verify help message with API team
92
91
publicstringCreateOption{get;set;}
93
92
94
93
[Parameter(
@@ -99,13 +98,13 @@ public partial class NewAzureRmSnapshotConfigCommand : Microsoft.Azure.Commands.
99
98
[Parameter(
100
99
Mandatory=false,
101
100
ValueFromPipelineByPropertyName=true,
102
-
HelpMessage="Sets the Purchase Plan for the Snapshot.")]
101
+
HelpMessage="Sets the purchase plan for the snapshot. Used for establishing the purchase context of any 3rd Party artifact through Marketplace.")]
103
102
publicPSPurchasePlanPurchasePlan{get;set;}
104
103
105
104
[Parameter(
106
105
Mandatory=false,
107
106
ValueFromPipelineByPropertyName=true,
108
-
HelpMessage="Specify if Disk Supports Hibernation with $true of $false")]
107
+
HelpMessage="Indicates if the OS on the snapshot supports hibernation with $true or $false")]
Copy file name to clipboardExpand all lines: src/Compute/Compute/RestorePoints/NewAzRestorePoint.cs
+11-7Lines changed: 11 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -34,48 +34,52 @@ public class NewAzureRestorePoint : ComputeAutomationBaseCmdlet
34
34
[Parameter(
35
35
Position=0,
36
36
Mandatory=true,
37
-
ValueFromPipelineByPropertyName=true)]
37
+
ValueFromPipelineByPropertyName=true,
38
+
HelpMessage="Resource group name this resource belongs to")]
38
39
[ResourceGroupCompleter]
39
40
publicstringResourceGroupName{get;set;}
40
41
41
42
[Parameter(
42
43
Position=1,
43
44
Mandatory=true,
44
-
ValueFromPipelineByPropertyName=true)]
45
+
ValueFromPipelineByPropertyName=true,
46
+
HelpMessage="Name of the restore point collection this restore point is part of")]
45
47
publicstringRestorePointCollectionName{get;set;}
46
48
47
49
[Parameter(
48
50
Position=1,
49
51
Mandatory=true,
50
-
ValueFromPipelineByPropertyName=true)]
52
+
ValueFromPipelineByPropertyName=true,
53
+
HelpMessage="The name of the restore point")]
51
54
[Alias("RestorePointName")]
52
55
publicstringName{get;set;}
53
56
54
57
[Parameter(
55
58
Position=3,
56
59
Mandatory=false,
57
60
ValueFromPipelineByPropertyName=false,
58
-
HelpMessage="Set the region of the Restore Point")]
61
+
HelpMessage="Set the region of the restore point")]
59
62
publicstringLocation{get;set;}
60
63
61
64
62
65
[Parameter(
63
66
Mandatory=false,
64
67
ValueFromPipeline=true,
65
-
HelpMessage="ARM Id of the source Restore Point")]
68
+
HelpMessage="ARM Id of the source restore point")]
66
69
publicstringRestorePointId{get;set;}
67
70
68
71
69
72
[Parameter(
70
73
Mandatory=false,
71
-
ValueFromPipeline=true)]
74
+
ValueFromPipeline=true,
75
+
HelpMessage="List of disk resource Id values that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.")]
72
76
publicstring[]DisksToExclude{get;set;}
73
77
74
78
75
79
[Parameter(
76
80
Mandatory=false,
77
81
ValueFromPipeline=true,
78
-
HelpMessage="ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.")]
82
+
HelpMessage="ConsistencyMode of the restore point. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.")]
Copy file name to clipboardExpand all lines: src/Compute/Compute/help/New-AzRestorePoint.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Creates a new Restore Point
33
33
## PARAMETERS
34
34
35
35
### -ConsistencyMode
36
-
ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
36
+
ConsistencyMode of the restore point. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
0 commit comments