Skip to content
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

Microsoft.AzureStackHCI new api preview - 2021-01-01-preview #21880

Merged
merged 4 commits into from
Jul 26, 2021

Conversation

mbialecka
Copy link
Contributor

@mbialecka mbialecka commented Jun 15, 2021

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.

  • If the check fails at the Verify Code Generation step, please ensure:

    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version.

    Note: We have recently updated the PSH module called by generate.ps1 to emit additional data. This would help reduce/eliminate the Code Verification check error. Please run following command:

      `dotnet msbuild eng/mgmt.proj /t:Util /p:UtilityName=InstallPsModules`
    

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

@mbialecka
Copy link
Contributor Author

SDK code was generated based on this spec (not yet merged to master):
Azure/azure-rest-api-specs#14480

@markcowl
Copy link
Member

@mbialecka marking as do not merge until the swagger is checked in - ci will fail until the swagger is there and you have regenerated using generate.ps1 from the checked-in version

@markcowl
Copy link
Member

@mbialecka Please let me know when the swagger is checked in and will proceed. Also, please read through and check the appropriate checkboxes in the PR form above.

@mbialecka
Copy link
Contributor Author

@markcowl The swagger is checked in.

@mbialecka
Copy link
Contributor Author

  1. How do I know if there are breaking changes? The code was generated. Is there any tools for this?
  2. There is no AzureRP.props but there is AzSdk.RP.props (and it was updated) - is it the same thing?

@mbialecka
Copy link
Contributor Author

@markcowl Do I need to do anything else to move this forward?

@mbialecka
Copy link
Contributor Author

@allenjzhang @markcowl ping

@mbialecka
Copy link
Contributor Author

@allenjzhang @m-nash @markcowl @nisha-bhatia @YalinLi0312 please help complete this

Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

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

A few changes needed to mitigate breaking changes from the last stable api.

@@ -834,7 +834,7 @@ public async Task<AzureOperationResponse<Cluster>> CreateWithHttpMessagesAsync(s
/// <return>
/// A response object containing the response body and response headers.
/// </return>
public async Task<AzureOperationResponse<Cluster>> UpdateWithHttpMessagesAsync(string resourceGroupName, string clusterName, IDictionary<string, string> tags = default(IDictionary<string, string>), Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
public async Task<AzureOperationResponse<Cluster>> UpdateWithHttpMessagesAsync(string resourceGroupName, string clusterName, ClusterPatch cluster, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
Copy link
Member

Choose a reason for hiding this comment

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

This is a breaking change from the previous version. If Tags can still be used to create a ClusterPatch, then this can be mitigated by adding a partial class that implements the old method in customizations. This would mean adding the same overload to 'IClustersOperations, ClustersOperations, and ClustersOperationsExtensions'. Adding a method with the signature:

 public async Task<AzureOperationResponse<Cluster>> UpdateWithHttpMessagesAsync(string resourceGroupName, string clusterName, IDictionary<string, string> tags, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))

That simply created a ClusterPatch object from the tags and called the existing method would work.

/// </param>
public static Cluster Update(this IClustersOperations operations, string resourceGroupName, string clusterName, IDictionary<string, string> tags = default(IDictionary<string, string>))
public static Cluster Update(this IClustersOperations operations, string resourceGroupName, string clusterName, ClusterPatch cluster)
Copy link
Member

Choose a reason for hiding this comment

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

similr method signatures needed here - again, a partial class in customizations will fix this.

@@ -144,7 +144,7 @@ public partial interface IClustersOperations
/// <exception cref="Microsoft.Rest.ValidationException">
/// Thrown when a required parameter is null
/// </exception>
Task<AzureOperationResponse<Cluster>> UpdateWithHttpMessagesAsync(string resourceGroupName, string clusterName, IDictionary<string, string> tags = default(IDictionary<string, string>), Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken));
Task<AzureOperationResponse<Cluster>> UpdateWithHttpMessagesAsync(string resourceGroupName, string clusterName, ClusterPatch cluster, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken));
Copy link
Member

Choose a reason for hiding this comment

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

third place that needs this change (a partial interface in customizations wil work).

@markcowl
Copy link
Member

@mbialecka Please take a look at the comments and let me know if you have any questions.

@markcowl markcowl merged commit 70f8a46 into Azure:main Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants