Changed a parameter name from VaultName to Name #10676

Skuldo · 2019-12-08T20:20:42Z

Changed a parameter name from VaultName to Name, and then added VaultName as an alias to make RemoveAzureKeyVault consistent with NewAzureKeyVault.

Description

See #10673

Checklist

I have read the Submitting Changes section of CONTRIBUTING.md
The title of the PR is clear and informative
The appropriate ChangeLog.md file(s) has been updated:
- For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
- A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header -- no new version header should be added
The PR does not introduce breaking changes
If applicable, the changes made in the PR have proper test coverage
For public API changes to cmdlets:
- a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
- the markdown help files have been regenerated using the commands listed here

msJinLei · 2019-12-09T02:03:07Z

@Skuldo Please add test cases & changelog to changelog.md

see Azure#10676

Skuldo · 2019-12-10T15:04:39Z

Updated ChangeLog #10687

I don't think any tests need amending, this is essentially just re-ordering the alias/class name, the existing way of interacting with it is identical, with the addition of an extra alias.

msJinLei · 2019-12-11T02:26:11Z

Updated ChangeLog #10687

I don't think any tests need amending, this is essentially just re-ordering the alias/class name, the existing way of interacting with it is identical, with the addition of an extra alias.

Please merge the changelog commit into this PR.

adxsdkps · 2019-12-11T19:25:38Z

Can one of the admins verify this patch?

msftclas · 2019-12-11T19:31:53Z

All CLA requirements met.

dingmeng-xue · 2019-12-12T03:12:47Z

We should use VaultName as default parameter name and Name as its alias.

msJinLei · 2019-12-13T03:31:49Z

@Skuldo Sorry, one more thing, help mark down file should also be upgraded.

Updated VaultName to Name for Azure#10676

msJinLei · 2019-12-16T05:40:16Z

src/KeyVault/KeyVault/Commands/RemoveAzureKeyVault.cs

@@ -54,7 +54,8 @@ public class RemoveAzureKeyVault : KeyVaultManagementCmdletBase
            HelpMessage = "Specifies the name of the key vault to remove.")]
        [ResourceNameCompleter("Microsoft.KeyVault/vaults", "ResourceGroupName")]
        [ValidateNotNullOrEmpty]
-        public string VaultName { get; set; }
+        [Alias("VaultName")]
+        public string Name { get; set; }


Is the original reference to VaultName required to be modified?

So @Skuldo , is there any particular reason why not keep VaultName as-is, and add Name as an alias?

msJinLei · 2020-01-10T05:56:03Z

Hi @Skuldo, Thank you for contributing to azure powershell. We will do inplace modification to your patch to finish the job.

Changed a parameter name from VaultName to Name, and then added VaultName as an alias to make RemoveAzureKeyVault consistent with NewAzureKeyVault.

* Reorganised Name/VaultName attribute to make Remove-AzureKeyVault consistent with New-AzureKeyVault.

Updated VaultName to Name for Azure#10676

msJinLei · 2020-01-16T06:08:57Z

/azp run

azure-pipelines · 2020-01-16T06:09:18Z

Azure Pipelines successfully started running 3 pipeline(s).

Require met

Updated VaultName to Name for Azure#10676

Changed a parameter name from VaultName to Name

azuresdkci added the needs-review label Dec 8, 2019

msJinLei self-assigned this Dec 9, 2019

msJinLei added needs-revision and removed needs-review labels Dec 9, 2019

msJinLei assigned Skuldo Dec 9, 2019

Skuldo added a commit to Skuldo/azure-powershell that referenced this pull request Dec 10, 2019

Update ChangeLog.md

2c55375

see Azure#10676

Skuldo added a commit to Skuldo/azure-powershell that referenced this pull request Dec 10, 2019

Update ChangeLog.md

3444088

see Azure#10676

Skuldo mentioned this pull request Dec 10, 2019

Update ChangeLog.md #10687

Closed

8 tasks

Skuldo added a commit to Skuldo/azure-powershell that referenced this pull request Dec 14, 2019

Update Remove-AzKeyVault.md

369d3e1

Updated VaultName to Name for Azure#10676

msJinLei previously requested changes Dec 16, 2019

View reviewed changes

Skuldo added 3 commits January 16, 2020 11:14

Changed a parameter name from VaultName to Name

cb94ab5

Changed a parameter name from VaultName to Name, and then added VaultName as an alias to make RemoveAzureKeyVault consistent with NewAzureKeyVault.

Update ChangeLog.md

e28653b

* Reorganised Name/VaultName attribute to make Remove-AzureKeyVault consistent with New-AzureKeyVault.

Update Remove-AzKeyVault.md

ff3a90e

Updated VaultName to Name for Azure#10676

msJinLei force-pushed the patch-1 branch from a13d4ec to 2979a5d Compare January 16, 2020 06:02

Restore VaultName of Remove-AzKeyVault and update help file accordingly

33524cc

msJinLei force-pushed the patch-1 branch from 2979a5d to 33524cc Compare January 16, 2020 06:05

msJinLei added needs-review and removed needs-revision labels Jan 16, 2020

msJinLei unassigned Skuldo Jan 16, 2020

msJinLei assigned isra-fel Jan 16, 2020

isra-fel approved these changes Jan 16, 2020

View reviewed changes

isra-fel merged commit 4dad5ca into Azure:master Jan 16, 2020

msJinLei mentioned this pull request Jan 16, 2020

New-AzKeyVault / Remove-AzKeyVault name attribute inconsistency #10673

Closed

dingmeng-xue pushed a commit to dingmeng-xue/azure-powershell that referenced this pull request Mar 29, 2020

Update Remove-AzKeyVault.md

86f5764

Updated VaultName to Name for Azure#10676

dingmeng-xue pushed a commit to dingmeng-xue/azure-powershell that referenced this pull request Mar 29, 2020

Merge pull request Azure#10676 from Skuldo/patch-1

239c9d9

Changed a parameter name from VaultName to Name

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Changed a parameter name from VaultName to Name #10676

Changed a parameter name from VaultName to Name #10676

Uh oh!

Skuldo commented Dec 8, 2019 •

edited

Loading

Uh oh!

msJinLei commented Dec 9, 2019

Uh oh!

Skuldo commented Dec 10, 2019

Uh oh!

msJinLei commented Dec 11, 2019

Uh oh!

adxsdkps commented Dec 11, 2019

Uh oh!

msftclas commented Dec 11, 2019 •

edited

Loading

Uh oh!

dingmeng-xue commented Dec 12, 2019

Uh oh!

msJinLei commented Dec 13, 2019

Uh oh!

msJinLei Dec 16, 2019

Uh oh!

isra-fel Dec 30, 2019

Uh oh!

msJinLei commented Jan 10, 2020 •

edited

Loading

Uh oh!

msJinLei commented Jan 16, 2020

Uh oh!

azure-pipelines bot commented Jan 16, 2020

Uh oh!

Uh oh!

Changed a parameter name from VaultName to Name #10676

Changed a parameter name from VaultName to Name #10676

Uh oh!

Conversation

Skuldo commented Dec 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

msJinLei commented Dec 9, 2019

Uh oh!

Skuldo commented Dec 10, 2019

Uh oh!

msJinLei commented Dec 11, 2019

Uh oh!

adxsdkps commented Dec 11, 2019

Uh oh!

msftclas commented Dec 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dingmeng-xue commented Dec 12, 2019

Uh oh!

msJinLei commented Dec 13, 2019

Uh oh!

msJinLei Dec 16, 2019

Choose a reason for hiding this comment

Uh oh!

isra-fel Dec 30, 2019

Choose a reason for hiding this comment

Uh oh!

msJinLei commented Jan 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

msJinLei commented Jan 16, 2020

Uh oh!

azure-pipelines bot commented Jan 16, 2020

Uh oh!

Uh oh!

Skuldo commented Dec 8, 2019 •

edited

Loading

msftclas commented Dec 11, 2019 •

edited

Loading

msJinLei commented Jan 10, 2020 •

edited

Loading