Skip to content

Breaking Change - Removed ApiVersion parameter from Az.Resources deployments cmdlets and changed the output type of Get-AzResourceGroupDeploymentOperations #13112

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.

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 26 commits into from
Oct 16, 2020

Conversation

Xynoclafe
Copy link
Contributor

@Xynoclafe Xynoclafe commented Sep 29, 2020

Description

Removed ApiVersion parameter from Az.Resources deployments cmdlets and changed the output type of Get-AzResourceGroupDeploymentOperations

This is a breaking change.
Design review - https://github.com/Azure/azure-powershell-cmdlet-review-pr/issues/707

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

@Xynoclafe Xynoclafe requested a review from filizt September 29, 2020 23:21
@Xynoclafe Xynoclafe changed the title Xynoclafe/apiversion Breaking Change - Removed ApiVersion parameter from Az.Resources deployments cmdlets and changed the output type of Get-AzResourceGroupDeploymentOperations Sep 29, 2020
@filizt
Copy link
Contributor

filizt commented Sep 30, 2020

public abstract class ResourceManagerCmdletBaseWithAPiVersion : ResourceManagerCmdletBase

Could you please fix the casing of "APi" in the class name?


Refers to: src/Resources/ResourceManager/Implementation/CmdletBase/ResourceManagerCmdletBaseWithAPiVersion.cs:21 in 6c9887e. [](commit_id = 6c9887e, deletion_comment = False)

@@ -18,6 +18,8 @@
- Additional information about change #1
-->
## Upcoming Release
* Updated `Get-AzResourceGroupDeploymentOperation`to use the SDK.
* Remove ApiVersion parameter
Copy link
Contributor

@filizt filizt Sep 30, 2020

Choose a reason for hiding this comment

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

I think it's a worthy effort to make the change longs a bit verbose to make things clear. We can add something like "Remove ApiVersion parameter from Deployment cmdlets" (if the cmdlet list is not too long, maybe add them too?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are quite a few cmdlets (mentioned in the design review), so I don't think adding them to the changelog is practical. But I'll make it a little more verbose.

@filizt
Copy link
Contributor

filizt commented Sep 30, 2020

Could you also add the link to the design discussion in the description section?

@isra-fel isra-fel self-assigned this Sep 30, 2020
@Xynoclafe
Copy link
Contributor Author

@isra-fel Can you please review this PR?

@isra-fel
Copy link
Member

isra-fel commented Oct 9, 2020

/azp run azure-powershell - windows-powershell

@azure-pipelines
Copy link
Contributor

No pipelines are associated with this pull request.

isra-fel
isra-fel previously approved these changes Oct 9, 2020
Copy link
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.

Sorry @Xynoclafe our team are just back from holiday. Anyway your changes LGTM. Thanks

@isra-fel isra-fel added Breaking Change Release This PR contains breaking change Waiting for CI :shipit: and removed needs-review labels Oct 9, 2020
@isra-fel
Copy link
Member

isra-fel commented Oct 9, 2020

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@Xynoclafe
Copy link
Contributor Author

Hi @isra-fel
Can you review the PR again? Your last commit voided your previous review. And I think we can remove the Waiting for CI label as CI seems to be passing now.

@isra-fel
Copy link
Member

@Xynoclafe I'm sorry but it seems the merge of #13090 has caused a lot of conflict in the test recording file. Would you please resolve them by merging master and record ResourceGroupDeploymentEndToEnd again?

Thanks in advance!

@isra-fel isra-fel merged commit 1cfab69 into Azure:master Oct 16, 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