diff --git a/src/Compute/Compute/ChangeLog.md b/src/Compute/Compute/ChangeLog.md index b0eea838e1a0..ff9561c502ee 100644 --- a/src/Compute/Compute/ChangeLog.md +++ b/src/Compute/Compute/ChangeLog.md @@ -21,6 +21,7 @@ --> ## Upcoming Release * Added `ConsistencyMode` parameter to `New-AzRestorePoint` +* Filled in missing parameter descriptions across multiple parameters and improved some existing parameter descriptions. ## Version 5.3.0 * 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. diff --git a/src/Compute/Compute/Generated/Disk/Config/NewAzureRmDiskUpdateConfigCommand.cs b/src/Compute/Compute/Generated/Disk/Config/NewAzureRmDiskUpdateConfigCommand.cs index 6952ba968868..e57a14e68f76 100644 --- a/src/Compute/Compute/Generated/Disk/Config/NewAzureRmDiskUpdateConfigCommand.cs +++ b/src/Compute/Compute/Generated/Disk/Config/NewAzureRmDiskUpdateConfigCommand.cs @@ -68,13 +68,15 @@ public partial class NewAzureRmDiskUpdateConfigCommand : Microsoft.Azure.Command [Parameter( Mandatory = false, - ValueFromPipelineByPropertyName = true)] + ValueFromPipelineByPropertyName = true, + HelpMessage = "Policy for accessing the disk via network. Available values are: AllowAll, AllowPrivate, DeyAll")] [PSArgumentCompleter("AllowAll", "AllowPrivate", "DenyAll")] public string NetworkAccessPolicy { get; set; } [Parameter( Mandatory = false, - ValueFromPipelineByPropertyName = true)] + ValueFromPipelineByPropertyName = true, + HelpMessage = "ARM id of the DiskAccess resource for using private endpoints on disks")] public string DiskAccessId { get; set; } [Parameter( @@ -108,18 +110,19 @@ public partial class NewAzureRmDiskUpdateConfigCommand : Microsoft.Azure.Command [Parameter( Mandatory = false, ValueFromPipelineByPropertyName = true, - HelpMessage = "Sets the Purchase Plan for the Disk")] + HelpMessage = "Sets the purchase plan for the disk. Used for establishing the purchase context of any 3rd Party artifact through Marketplace.")] public PSPurchasePlan PurchasePlan { get; set; } [Parameter( Mandatory = false, ValueFromPipelineByPropertyName = true, - HelpMessage = "Specify if Disk Supports Hibernation with $true of $false")] + HelpMessage = "Indicates if the OS on the disk supports hibernation with $true or $false")] public bool? SupportsHibernation { get; set; } [Parameter( Mandatory = false, - ValueFromPipelineByPropertyName = true)] + ValueFromPipelineByPropertyName = true, + HelpMessage = "Enable encryption settings on the disk")] public bool? EncryptionSettingsEnabled { get; set; } [Parameter( @@ -138,7 +141,8 @@ public partial class NewAzureRmDiskUpdateConfigCommand : Microsoft.Azure.Command [Parameter( Mandatory = false, - ValueFromPipelineByPropertyName = true)] + ValueFromPipelineByPropertyName = true, + HelpMessage = "The type of key used to encrypt the data of the disk. Available values are: EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerKey")] [PSArgumentCompleter("EncryptionAtRestWithPlatformKey", "EncryptionAtRestWithCustomerKey")] public string EncryptionType { get; set; } diff --git a/src/Compute/Compute/Generated/DiskEncryptionSet/DiskEncryptionSetUpdateMethod.cs b/src/Compute/Compute/Generated/DiskEncryptionSet/DiskEncryptionSetUpdateMethod.cs index 6aa2e881e453..00540f2707b8 100644 --- a/src/Compute/Compute/Generated/DiskEncryptionSet/DiskEncryptionSetUpdateMethod.cs +++ b/src/Compute/Compute/Generated/DiskEncryptionSet/DiskEncryptionSetUpdateMethod.cs @@ -129,7 +129,7 @@ public override void ExecuteCmdlet() [Parameter( Mandatory = false, ValueFromPipelineByPropertyName = true, - HelpMessage = "Gets or sets set this flag to true to enable auto-updating of this disk encryption")] + HelpMessage = "Set this flag to true to enable auto-updating of this disk encryption set to the latest key version")] public bool? RotationToLatestKeyVersionEnabled { get; set; } [Parameter( diff --git a/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotConfigCommand.cs b/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotConfigCommand.cs index 9cb5b6ee1a95..2d8ed2fdf51f 100644 --- a/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotConfigCommand.cs +++ b/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotConfigCommand.cs @@ -88,7 +88,6 @@ public partial class NewAzureRmSnapshotConfigCommand : Microsoft.Azure.Commands. Mandatory = false, ValueFromPipelineByPropertyName = true, 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")] - //todo: verify help message with API team public string CreateOption { get; set; } [Parameter( @@ -99,13 +98,13 @@ public partial class NewAzureRmSnapshotConfigCommand : Microsoft.Azure.Commands. [Parameter( Mandatory = false, ValueFromPipelineByPropertyName = true, - HelpMessage = "Sets the Purchase Plan for the Snapshot.")] + HelpMessage = "Sets the purchase plan for the snapshot. Used for establishing the purchase context of any 3rd Party artifact through Marketplace.")] public PSPurchasePlan PurchasePlan { get; set; } [Parameter( Mandatory = false, ValueFromPipelineByPropertyName = true, - HelpMessage = "Specify if Disk Supports Hibernation with $true of $false")] + HelpMessage = "Indicates if the OS on the snapshot supports hibernation with $true or $false")] public bool? SupportsHibernation { get; set; } [Parameter( diff --git a/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotUpdateConfigCommand.cs b/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotUpdateConfigCommand.cs index d250463df4e1..9352c48dce6e 100644 --- a/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotUpdateConfigCommand.cs +++ b/src/Compute/Compute/Generated/Snapshot/Config/NewAzureRmSnapshotUpdateConfigCommand.cs @@ -64,7 +64,7 @@ public partial class NewAzureRmSnapshotUpdateConfigCommand : Microsoft.Azure.Com [Parameter( Mandatory = false, ValueFromPipelineByPropertyName = true, - HelpMessage = "Specify if Disk Supports Hibernation with $true of $false")] + HelpMessage = "Indicates if the OS on the snapshot supports hibernation with $true or $false")] public bool? SupportsHibernation { get; set; } diff --git a/src/Compute/Compute/RestorePoints/NewAzRestorePoint.cs b/src/Compute/Compute/RestorePoints/NewAzRestorePoint.cs index 705a52ae9196..93eaae91c556 100644 --- a/src/Compute/Compute/RestorePoints/NewAzRestorePoint.cs +++ b/src/Compute/Compute/RestorePoints/NewAzRestorePoint.cs @@ -34,20 +34,23 @@ public class NewAzureRestorePoint : ComputeAutomationBaseCmdlet [Parameter( Position = 0, Mandatory = true, - ValueFromPipelineByPropertyName = true)] + ValueFromPipelineByPropertyName = true, + HelpMessage = "Resource group name this resource belongs to")] [ResourceGroupCompleter] public string ResourceGroupName { get; set; } [Parameter( Position = 1, Mandatory = true, - ValueFromPipelineByPropertyName = true)] + ValueFromPipelineByPropertyName = true, + HelpMessage = "Name of the restore point collection this restore point is part of")] public string RestorePointCollectionName{ get; set; } [Parameter( Position = 1, Mandatory = true, - ValueFromPipelineByPropertyName = true)] + ValueFromPipelineByPropertyName = true, + HelpMessage = "The name of the restore point")] [Alias("RestorePointName")] public string Name { get; set; } @@ -55,27 +58,28 @@ public class NewAzureRestorePoint : ComputeAutomationBaseCmdlet Position = 3, Mandatory = false, ValueFromPipelineByPropertyName = false, - HelpMessage = "Set the region of the Restore Point")] + HelpMessage = "Set the region of the restore point")] public string Location { get; set; } [Parameter( Mandatory = false, ValueFromPipeline = true, - HelpMessage = "ARM Id of the source Restore Point")] + HelpMessage = "ARM Id of the source restore point")] public string RestorePointId { get; set; } [Parameter( Mandatory = false, - ValueFromPipeline = true)] + ValueFromPipeline = true, + 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.")] public string[] DisksToExclude { get; set; } [Parameter( Mandatory = false, ValueFromPipeline = true, - 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.")] + 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.")] [PSArgumentCompleter("CrashConsistent", "FileSystemConsistent", "ApplicationConsistent")] public string ConsistencyMode { get; set; } diff --git a/src/Compute/Compute/help/New-AzDiskUpdateConfig.md b/src/Compute/Compute/help/New-AzDiskUpdateConfig.md index c8e547413107..3c4bef050e26 100644 --- a/src/Compute/Compute/help/New-AzDiskUpdateConfig.md +++ b/src/Compute/Compute/help/New-AzDiskUpdateConfig.md @@ -132,7 +132,7 @@ Accept wildcard characters: False ``` ### -DiskAccessId -{{ Fill DiskAccessId Description }} +ARM id of the DiskAccess resource for using private endpoints on disks ```yaml Type: System.String @@ -252,7 +252,7 @@ Accept wildcard characters: False ``` ### -EncryptionSettingsEnabled -Enable encryption settings. +Enable encryption settings on the disk ```yaml Type: System.Nullable`1[System.Boolean] @@ -267,7 +267,7 @@ Accept wildcard characters: False ``` ### -EncryptionType -The type of key used to encrypt the data of the disk. Available values are: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey' +The type of key used to encrypt the data of the disk. Available values are: EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerKey ```yaml Type: System.String @@ -312,7 +312,7 @@ Accept wildcard characters: False ``` ### -NetworkAccessPolicy -{{ Fill NetworkAccessPolicy Description }} +Policy for accessing the disk via network. Available values are: AllowAll, AllowPrivate, DeyAll ```yaml Type: System.String @@ -358,7 +358,7 @@ Accept wildcard characters: False ``` ### -PurchasePlan -{{ Fill PurchasePlan Description }} +Sets the purchase plan for the disk. Used for establishing the purchase context of any 3rd Party artifact through Marketplace. ```yaml Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan @@ -388,7 +388,7 @@ Accept wildcard characters: False ``` ### -SupportsHibernation -{{ Fill SupportsHibernation Description }} +Indicates if the OS on the disk supports hibernation with $true or $false ```yaml Type: System.Nullable`1[System.Boolean] diff --git a/src/Compute/Compute/help/New-AzRestorePoint.md b/src/Compute/Compute/help/New-AzRestorePoint.md index 307a13c11e38..a36ec401d56c 100644 --- a/src/Compute/Compute/help/New-AzRestorePoint.md +++ b/src/Compute/Compute/help/New-AzRestorePoint.md @@ -33,7 +33,7 @@ Creates a new Restore Point ## PARAMETERS ### -ConsistencyMode -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. +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. ```yaml Type: System.String @@ -63,7 +63,7 @@ Accept wildcard characters: False ``` ### -DisksToExclude -List of disk resource ids that the customer wishes to exclude from the restorepoint. If no disks are specified, all disks will be included. +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. ```yaml Type: System.String[] @@ -78,7 +78,7 @@ Accept wildcard characters: False ``` ### -Location -{{ Fill Location Description }} +Set the region of the restore point ```yaml Type: System.String @@ -93,7 +93,7 @@ Accept wildcard characters: False ``` ### -Name -Resource Name +The name of the restore point ```yaml Type: System.String @@ -108,7 +108,7 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -Resource Group Name +Resource group name this resource belongs to ```yaml Type: System.String @@ -123,7 +123,7 @@ Accept wildcard characters: False ``` ### -RestorePointCollectionName -Restore Point Collection Name +Name of the restore point collection this restore point is part of ```yaml Type: System.String @@ -138,7 +138,7 @@ Accept wildcard characters: False ``` ### -RestorePointId -{{ Fill RestorePointId Description }} +ARM Id of the source restore point ```yaml Type: System.String diff --git a/src/Compute/Compute/help/New-AzSnapshotConfig.md b/src/Compute/Compute/help/New-AzSnapshotConfig.md index 49d12c45e307..86e01109f189 100644 --- a/src/Compute/Compute/help/New-AzSnapshotConfig.md +++ b/src/Compute/Compute/help/New-AzSnapshotConfig.md @@ -362,7 +362,7 @@ Accept wildcard characters: False ``` ### -PurchasePlan -{{ Fill PurchasePlan Description }} +Sets the purchase plan for the snapshot. Used for establishing the purchase context of any 3rd Party artifact through Marketplace. ```yaml Type: Microsoft.Azure.Commands.Compute.Automation.Models.PSPurchasePlan @@ -437,7 +437,7 @@ Accept wildcard characters: False ``` ### -SupportsHibernation -{{ Fill SupportsHibernation Description }} +Indicates if the OS on the snapshot supports hibernation with $true or $false ```yaml Type: System.Nullable`1[System.Boolean] diff --git a/src/Compute/Compute/help/New-AzSnapshotUpdateConfig.md b/src/Compute/Compute/help/New-AzSnapshotUpdateConfig.md index fae46f3e3101..0f2f3224c80a 100644 --- a/src/Compute/Compute/help/New-AzSnapshotUpdateConfig.md +++ b/src/Compute/Compute/help/New-AzSnapshotUpdateConfig.md @@ -251,7 +251,7 @@ Accept wildcard characters: False ``` ### -SupportsHibernation -{{ Fill SupportsHibernation Description }} +Indicates if the OS on the snapshot supports hibernation with $true or $false ```yaml Type: System.Nullable`1[System.Boolean] diff --git a/src/Compute/Compute/help/Update-AzDiskEncryptionSet.md b/src/Compute/Compute/help/Update-AzDiskEncryptionSet.md index 3e778b70599f..98926c50dfc9 100644 --- a/src/Compute/Compute/help/Update-AzDiskEncryptionSet.md +++ b/src/Compute/Compute/help/Update-AzDiskEncryptionSet.md @@ -171,7 +171,7 @@ Accept wildcard characters: False ``` ### -RotationToLatestKeyVersionEnabled -{{ Fill RotationToLatestKeyVersionEnabled Description }} +Set this flag to true to enable auto-updating of this disk encryption set to the latest key version ```yaml Type: System.Nullable`1[System.Boolean]