[Resources] Fix help message for -Name parameter of deployment cmdlets (#12139)

shenglol · web-flow · commit cc92ebb15270 · 2020-06-13T11:07:09.000+08:00
* Fix help message for -Name parameter

* Update ChangeLog.md
diff --git a/src/Resources/ResourceManager/Implementation/Deployments/GetAzureSubscriptionDeploymentWhatIfResultCmdlet.cs b/src/Resources/ResourceManager/Implementation/Deployments/GetAzureSubscriptionDeploymentWhatIfResultCmdlet.cs
@@ -37,7 +37,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     public class GetAzureSubscriptionDeploymentWhatIfResultCmdlet : ResourceWithParameterCmdletBase, IDynamicParameters
     {
         [Alias("DeploymentName")]
-        [Parameter(Mandatory = false, HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]
+        [Parameter(Mandatory = false, HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
diff --git a/src/Resources/ResourceManager/Implementation/Deployments/NewAzureManagementGroupDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/Deployments/NewAzureManagementGroupDeploymentCmdlet.cs
@@ -34,7 +34,7 @@ public class NewAzureManagementGroupDeploymentCmdlet : ResourceWithParameterCmdl
     {
         [Alias("DeploymentName")]
         [Parameter(Mandatory = false,
-            HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]
+            HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
diff --git a/src/Resources/ResourceManager/Implementation/Deployments/NewAzureSubscriptionDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/Deployments/NewAzureSubscriptionDeploymentCmdlet.cs
@@ -38,7 +38,7 @@ public class NewAzureSubscriptionDeploymentCmdlet : ResourceWithParameterCmdletB
     {
         [Alias("DeploymentName")]
         [Parameter(Mandatory = false,
-            HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]
+            HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
diff --git a/src/Resources/ResourceManager/Implementation/Deployments/NewAzureTenantDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/Deployments/NewAzureTenantDeploymentCmdlet.cs
@@ -34,7 +34,7 @@ public class NewAzureTenantDeploymentCmdlet : ResourceWithParameterCmdletBase, I
     {
         [Alias("DeploymentName")]
         [Parameter(Mandatory = false,
-            HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]
+            HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
diff --git a/src/Resources/ResourceManager/Implementation/ResourceGroupDeployments/GetAzureResourceGroupDeploymentWhatIfResultCmdlet.cs b/src/Resources/ResourceManager/Implementation/ResourceGroupDeployments/GetAzureResourceGroupDeploymentWhatIfResultCmdlet.cs
@@ -30,7 +30,7 @@ public class GetAzureResourceGroupDeploymentWhatIfResultCmdlet : ResourceWithPar
     {
         [Alias("DeploymentName")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true,
-            HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]
+            HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
diff --git a/src/Resources/ResourceManager/Implementation/ResourceGroupDeployments/NewAzureResourceGroupDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/ResourceGroupDeployments/NewAzureResourceGroupDeploymentCmdlet.cs
@@ -35,7 +35,7 @@ public class NewAzureResourceGroupDeploymentCmdlet : ResourceWithParameterCmdlet
     {
         [Alias("DeploymentName")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true,
-            HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]
+            HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
diff --git a/src/Resources/Resources/ChangeLog.md b/src/Resources/Resources/ChangeLog.md
@@ -23,6 +23,7 @@
 * Added `-ExcludeChangeType` parameter to `Get-AzDeploymentWhatIfResult` and `Get-AzResourceGroupDeploymentWhatIfResult`
 * Added `-WhatIfExcludeChangeType` parameter to `New-AzDeployment` and `New-AzResourceGroupDeployment`
 * Updated `Test-Az*Deployment` cmdlets to show better error messages
+* Fixed help message for `-Name` parameter of deployment create and What-If cmdlets
 
 ## Version 2.1.0
 * Added Tail parameter to Get-AzDeploymentScriptLog and Save-AzDeploymentScriptLog cmdlets
diff --git a/src/Resources/Resources/help/Get-AzDeploymentWhatIfResult.md b/src/Resources/Resources/help/Get-AzDeploymentWhatIfResult.md
@@ -206,9 +206,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-The name of the deployment it's going to create.
-Only valid when a template is used.
-When a template is used, if the user doesn't specify a deployment name, use the current time, like "20131223140835".
+The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835".
 
 ```yaml
 Type: System.String
diff --git a/src/Resources/Resources/help/Get-AzResourceGroupDeploymentWhatIfResult.md b/src/Resources/Resources/help/Get-AzResourceGroupDeploymentWhatIfResult.md
@@ -210,9 +210,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-The name of the deployment it's going to create.
-Only valid when a template is used.
-When a template is used, if the user doesn't specify a deployment name, use the current time, like "20131223140835".
+The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835".
 
 ```yaml
 Type: System.String
diff --git a/src/Resources/Resources/help/New-AzDeployment.md b/src/Resources/Resources/help/New-AzDeployment.md
@@ -236,9 +236,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-The name of the deployment it's going to create.
-Only valid when a template is used.
-When a template is used, if the user doesn't specify a deployment name, use the current time, like "20131223140835".
+The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835".
 
 ```yaml
 Type: System.String
diff --git a/src/Resources/Resources/help/New-AzManagementGroupDeployment.md b/src/Resources/Resources/help/New-AzManagementGroupDeployment.md
@@ -256,9 +256,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-The name of the deployment it's going to create.
-Only valid when a template is used.
-When a template is used, if the user doesn't specify a deployment name, use the current time, like "20131223140835".
+The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835".
 
 ```yaml
 Type: System.String
diff --git a/src/Resources/Resources/help/New-AzResourceGroupDeployment.md b/src/Resources/Resources/help/New-AzResourceGroupDeployment.md
@@ -274,7 +274,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-Specifies the name of the resource group deployment to create.
+The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835".
 
 ```yaml
 Type: System.String
diff --git a/src/Resources/Resources/help/New-AzTenantDeployment.md b/src/Resources/Resources/help/New-AzTenantDeployment.md
@@ -219,9 +219,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-The name of the deployment it's going to create.
-Only valid when a template is used.
-When a template is used, if the user doesn't specify a deployment name, use the current time, like "20131223140835".
+The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. "20131223140835".
 
 ```yaml
 Type: String

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation`
`37`	`37`	`public class GetAzureSubscriptionDeploymentWhatIfResultCmdlet : ResourceWithParameterCmdletBase, IDynamicParameters`
`38`	`38`	`{`
`39`	`39`	`[Alias("DeploymentName")]`
`40`		`- [Parameter(Mandatory = false, HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]`
	`40`	`+ [Parameter(Mandatory = false, HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]`
`41`	`41`	`[ValidateNotNullOrEmpty]`
`42`	`42`	`public string Name { get; set; }`
`43`	`43`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public class NewAzureManagementGroupDeploymentCmdlet : ResourceWithParameterCmdl`
`34`	`34`	`{`
`35`	`35`	`[Alias("DeploymentName")]`
`36`	`36`	`[Parameter(Mandatory = false,`
`37`		`- HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]`
	`37`	`+ HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]`
`38`	`38`	`[ValidateNotNullOrEmpty]`
`39`	`39`	`public string Name { get; set; }`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public class NewAzureSubscriptionDeploymentCmdlet : ResourceWithParameterCmdletB`
`38`	`38`	`{`
`39`	`39`	`[Alias("DeploymentName")]`
`40`	`40`	`[Parameter(Mandatory = false,`
`41`		`- HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]`
	`41`	`+ HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]`
`42`	`42`	`[ValidateNotNullOrEmpty]`
`43`	`43`	`public string Name { get; set; }`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public class GetAzureResourceGroupDeploymentWhatIfResultCmdlet : ResourceWithPar`
`30`	`30`	`{`
`31`	`31`	`[Alias("DeploymentName")]`
`32`	`32`	`[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true,`
`33`		`- HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]`
	`33`	`+ HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]`
`34`	`34`	`[ValidateNotNullOrEmpty]`
`35`	`35`	`public string Name { get; set; }`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public class NewAzureResourceGroupDeploymentCmdlet : ResourceWithParameterCmdlet`
`35`	`35`	`{`
`36`	`36`	`[Alias("DeploymentName")]`
`37`	`37`	`[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true,`
`38`		`- HelpMessage = "The name of the deployment it's going to create. Only valid when a template is used. When a template is used, if the user doesn't specify a deployment name, use the current time, like \"20131223140835\".")]`
	`38`	`+ HelpMessage = "The name of the deployment it's going to create. If not specified, defaults to the template file name when a template file is provided; defaults to the current time when a template object is provided, e.g. \"20131223140835\".")]`
`39`	`39`	`[ValidateNotNullOrEmpty]`
`40`	`40`	`public string Name { get; set; }`
`41`	`41`