Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 13, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0205e43
Fix help message for -Name parameter
shenglol Jun 12, 2020
2cfef6d
Update ChangeLog.md
shenglol Jun 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...rceManager/Implementation/Deployments/GetAzureSubscriptionDeploymentWhatIfResultCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down
2 changes: 1 addition & 1 deletion ...ces/ResourceManager/Implementation/Deployments/NewAzureManagementGroupDeploymentCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down
2 changes: 1 addition & 1 deletion ...ources/ResourceManager/Implementation/Deployments/NewAzureSubscriptionDeploymentCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down
2 changes: 1 addition & 1 deletion src/Resources/ResourceManager/Implementation/Deployments/NewAzureTenantDeploymentCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down
2 changes: 1 addition & 1 deletion ...lementation/ResourceGroupDeployments/GetAzureResourceGroupDeploymentWhatIfResultCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down
2 changes: 1 addition & 1 deletion ...eManager/Implementation/ResourceGroupDeployments/NewAzureResourceGroupDeploymentCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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; }

Expand Down
1 change: 1 addition & 0 deletions src/Resources/Resources/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions src/Resources/Resources/help/Get-AzDeploymentWhatIfResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions src/Resources/Resources/help/Get-AzResourceGroupDeploymentWhatIfResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions src/Resources/Resources/help/New-AzDeployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions src/Resources/Resources/help/New-AzManagementGroupDeployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Resources/help/New-AzResourceGroupDeployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions src/Resources/Resources/help/New-AzTenantDeployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down