Skip to content

[RecoveryServices.Backup] Modifying breaking change warning in Get-AzRecoveryServicesBackupJobDetails Cmdlet#13389

Merged
isra-fel merged 1 commit intoAzure:masterfrom
MabOneSdk:hiaga/JobBrkChng
Nov 4, 2020
Merged

[RecoveryServices.Backup] Modifying breaking change warning in Get-AzRecoveryServicesBackupJobDetails Cmdlet#13389
isra-fel merged 1 commit intoAzure:masterfrom
MabOneSdk:hiaga/JobBrkChng

Conversation

@hiaga
Copy link
Copy Markdown
Member

@hiaga hiaga commented Nov 2, 2020

Description

Modifying breaking change warning in Get-AzRecoveryServicesBackupJobDetails cmdlet

Checklist

  • [Yes] I have read the Submitting Changes section of CONTRIBUTING.md
  • [Yes] The title of the PR is clear and informative
  • [Yes] 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
  • [Yes] The PR does not introduce breaking changes
  • [N/A] If applicable, the changes made in the PR have proper test coverage
  • [N/A] For public API changes to cmdlets:
    • [N/A] a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
    • [N/A] the markdown help files have been regenerated using the commands listed here

@isra-fel
Copy link
Copy Markdown
Member

isra-fel commented Nov 3, 2020

Hi @hiaga the reason we put that breaking change warning, I believe, is that we preferred to remove the alias, becuase it was against our design guideline.

For the same reason, rather than keeping the alias, I still hope it can be removed in next breaking change release (~April 2021). What do you think?

@isra-fel isra-fel self-assigned this Nov 3, 2020
@pvrk
Copy link
Copy Markdown
Member

pvrk commented Nov 3, 2020

@isra-fel : Thanks for the clarification. Can you please summarize what is the end result for the customer? Apologies, but I didn't understand the exact problem by reading the design guidelines.

@isra-fel
Copy link
Copy Markdown
Member

isra-fel commented Nov 3, 2020

By removing the alias, the end result would be that customers can only use "Get-AzRecoveryServicesBackupJobDetail" to call the command. If they use "Get-AzRecoveryServicesBackupJobDetails" PowerShell won't recognize it.

The design guideline simply needs cmdlet name to be singular. It's a powershell convention that we'd like all our cmdlets to follow.

@hiaga hiaga changed the title [RecoveryServices.Backup] Removing breaking change warning from Get-AzRecoveryServicesBackupJob… [RecoveryServices.Backup] Removing breaking change warning from Get-AzRecoveryServicesBackupJobDetails Cmdlet Nov 3, 2020
@hiaga
Copy link
Copy Markdown
Member Author

hiaga commented Nov 3, 2020

@isra-fel I'll modify the breaking change warning instead and make it singular in upcoming breaking change release.

Do we have any next breaking change release version ? I want to modify the warning message.

@hiaga hiaga force-pushed the hiaga/JobBrkChng branch 2 times, most recently from 028b8cb to 9f3350f Compare November 4, 2020 04:12
@hiaga hiaga changed the title [RecoveryServices.Backup] Removing breaking change warning from Get-AzRecoveryServicesBackupJobDetails Cmdlet [RecoveryServices.Backup] Modifying breaking change warning in Get-AzRecoveryServicesBackupJobDetails Cmdlet Nov 4, 2020
@hiaga hiaga added needs-review and removed Discuss labels Nov 4, 2020
Copy link
Copy Markdown
Member

@isra-fel isra-fel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. LGTM!

@isra-fel isra-fel merged commit 7253471 into Azure:master Nov 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants