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

rotate passwords for AVS 2020-07-17-preview #12290

Merged
merged 2 commits into from
Jan 13, 2021

Conversation

ctaggart
Copy link
Contributor

@ctaggart ctaggart commented Jan 5, 2021

This removes a breaking change in the 2020-07-17-preview to make it compatible with the 2020-03-20 API. I'm backporting it from the 2021-01-01-preview API in development. We are aware that this is a breaking change to the 2020-07-17-preview API and I will review it with the review board. No SDKs have been published for this API version. Rotate password functionality is not currently working in production. This will allow it to work.

This pull requests adds two actions for rotate passwords. Here is how the actions can be invoked:

az resource invoke-action --action rotateVcenterPassword  \
--ids /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}

az resource invoke-action --action rotateNsxtPassword \
--ids /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @ctaggart Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 5, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @ctaggart your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 5, 2021

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]

    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'vcenterPassword' renamed or removed?
    New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L3995:7
    Old: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L3909:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'nsxtPassword' renamed or removed?
    New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L3995:7
    Old: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L3909:7
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L586:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.AVS/preview/2020-07-17-preview/vmware.json#L629:5
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 5, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c7a5ce9. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
    • ️✔️@azure/arm-avs [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/avsClient.js → ./dist/arm-avs.js...
      cmderr	[npmPack] created ./dist/arm-avs.js in 582ms
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c7a5ce9. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6320 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
    • ️✔️vmware [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager]  SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c7a5ce9. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-01-13 05:50:44 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-avs"
      cmderr	[generate.py] 2021-01-13 05:50:44 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-01-13 05:50:44 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.8 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/avs/azure-resourcemanager-avs --java.namespace=com.azure.resourcemanager.avs  --package-version=1.0.0-beta.1 --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
      cmderr	[generate.py] 2021-01-13 05:51:33 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-01-13 05:51:33 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-01-13 05:51:33 INFO [POM][Skip] pom already has module azure-resourcemanager-avs
      cmderr	[generate.py] 2021-01-13 05:51:33 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-01-13 05:51:33 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-01-13 05:51:33 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
      cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
      cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
      cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
      cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release
    • ️✔️azure-resourcemanager-avs [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-01-13 05:54:25 DEBUG Got artifact_id: azure-resourcemanager-avs
      cmderr	[Inst] 2021-01-13 05:54:25 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-01-13 05:54:25 DEBUG Got artifact: azure-resourcemanager-avs-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-13 05:54:25 DEBUG Match jar package: azure-resourcemanager-avs-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-13 05:54:25 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12290/azure-sdk-for-java/azure-resourcemanager-avs/azure-resourcemanager-avs-1.0.0-beta.1.jar\" -o azure-resourcemanager-avs-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-avs -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-avs-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c7a5ce9. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
    • ️✔️azure-mgmt-avs [View full logs]  [Release SDK Changes] Breaking Change Detected
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-avs
      cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
      cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
      cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-avs
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
      cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.avs
      cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.avs
      cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.avs
      cmderr	[changelogReport] INFO:__main__:Report written to sdk/compute/azure-mgmt-avs/code_reports/latest/report.json
      cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-avs on PyPI
      cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '1.0.0rc1', '1.0.0']
      cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
      cmderr	[changelogReportLatest] INFO:__main__:Installing version 1.0.0 of azure-mgmt-avs in a venv
      cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
      cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.avs
      cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.avs
      cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.avs
      cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/compute/azure-mgmt-avs/code_reports/1.0.0/report.json
      cmdout	[Changelog] Size of delta 62.583% size of original (original: 56038 chars, delta: 35070 chars)
      cmdout	[Changelog] **Features**
      cmdout	[Changelog]   - Model MetricDimension has a new parameter internal_name
      cmdout	[Changelog]   - Model MetricDimension has a new parameter to_be_exported_for_shoebox
      cmdout	[Changelog]   - Added operation PrivateCloudsOperations.rotate_vcenter_password
      cmdout	[Changelog]   - Added operation PrivateCloudsOperations.rotate_nsxt_password
      cmdout	[Changelog]   - Added operation group GlobalReachConnectionsOperations
      cmdout	[Changelog]   - Added operation group WorkloadNetworksOperations
      cmdout	[Changelog]   - Added operation group AddonsOperations
      cmdout	[Changelog] **Breaking changes**
      cmdout	[Changelog]   - Operation ClustersOperations.create_or_update has a new signature
      cmdout	[Changelog]   - Operation ClustersOperations.create_or_update has a new signature
      cmdout	[Changelog]   - Operation HcxEnterpriseSitesOperations.create_or_update has a new signature
      cmdout	[Changelog]   - Operation AuthorizationsOperations.create_or_update has a new signature
      warn	Breaking change found in changelog
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c7a5ce9. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/vmware/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.Avs [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c7a5ce9. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/avs/mgmt/2020-07-17-preview/avs [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 60 items here, please refer to log for details.
      info	[Changelog] - New function `WorkloadNetworkDNSZonesListIterator.Response() WorkloadNetworkDNSZonesList`
      info	[Changelog] - New function `WorkloadNetworkDNSZonesListIterator.NotDone() bool`
      info	[Changelog] - New function `WorkloadNetworksClient.DeleteDNSZoneResponder(*http.Response) (autorest.Response, error)`
      info	[Changelog] - New function `WorkloadNetworkDNSServicesListIterator.Value() WorkloadNetworkDNSService`
      info	[Changelog] - New function `WorkloadNetworksClient.UpdateDNSService(context.Context, string, string, string, WorkloadNetworkDNSService) (WorkloadNetworksUpdateDNSServiceFuture, error)`
      info	[Changelog] - New function `PrivateCloudsClient.RotateVcenterPassword(context.Context, string, string) (PrivateCloudsRotateVcenterPasswordFuture, error)`
      info	[Changelog] - New function `WorkloadNetworkDNSServiceProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `*AddonListPage.Next() error`
      info	[Changelog] - New function `AddonsClient.DeleteSender(*http.Request) (AddonsDeleteFuture, error)`
      info	[Changelog] - New function `AddonsClient.Delete(context.Context, string, string, string) (AddonsDeleteFuture, error)`
      info	[Changelog] - New function `WorkloadNetworkDNSServicesList.IsEmpty() bool`
      info	[Changelog] - New function `Addon.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `NewWorkloadNetworkDNSZonesListPage(WorkloadNetworkDNSZonesList, func(context.Context, WorkloadNetworkDNSZonesList) (WorkloadNetworkDNSZonesList, error)) WorkloadNetworkDNSZonesListPage`
      info	[Changelog] - New function `AddonsClient.CreateOrUpdatePreparer(context.Context, string, string, string, Addon) (*http.Request, error)`
      info	[Changelog] - New function `AddonProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `WorkloadNetworksClient.CreateDNSZoneSender(*http.Request) (WorkloadNetworksCreateDNSZoneFuture, error)`
      info	[Changelog] - New function `AddonListIterator.Response() AddonList`
      info	[Changelog] - New function `*WorkloadNetworkDNSServicesListIterator.NextWithContext(context.Context) error`
      info	[Changelog] - New function `*WorkloadNetworkDNSService.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `PrivateCloudsClient.RotateVcenterPasswordResponder(*http.Response) (autorest.Response, error)`
      info	[Changelog] - New function `WorkloadNetworksClient.ListDNSZonesComplete(context.Context, string, string) (WorkloadNetworkDNSZonesListIterator, error)`
      info	[Changelog] - New function `WorkloadNetworksClient.ListDNSServicesPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `AddonsClient.List(context.Context, string, string) (AddonListPage, error)`
      info	[Changelog] - New function `WorkloadNetworkDNSZonesList.IsEmpty() bool`
      info	[Changelog] - New function `WorkloadNetworksClient.ListDNSZonesResponder(*http.Response) (WorkloadNetworkDNSZonesList, error)`
      info	[Changelog] - New function `PossibleDNSServiceStatusEnumValues() []DNSServiceStatusEnum`
      info	[Changelog] - New struct `Addon`
      info	[Changelog] - New struct `AddonList`
      info	[Changelog] - New struct `AddonListIterator`
      info	[Changelog] - New struct `AddonListPage`
      info	[Changelog] - New struct `AddonProperties`
      info	[Changelog] - New struct `AddonSrmProperties`
      info	[Changelog] - New struct `AddonUpdate`
      info	[Changelog] - New struct `AddonUpdateProperties`
      info	[Changelog] - New struct `AddonsClient`
      info	[Changelog] - New struct `AddonsCreateOrUpdateFuture`
      info	[Changelog] - New struct `AddonsDeleteFuture`
      info	[Changelog] - New struct `PrivateCloudsRotateNsxtPasswordFuture`
      info	[Changelog] - New struct `PrivateCloudsRotateVcenterPasswordFuture`
      info	[Changelog] - New struct `WorkloadNetworkDNSService`
      info	[Changelog] - New struct `WorkloadNetworkDNSServiceProperties`
      info	[Changelog] - New struct `WorkloadNetworkDNSServicesList`
      info	[Changelog] - New struct `WorkloadNetworkDNSServicesListIterator`
      info	[Changelog] - New struct `WorkloadNetworkDNSServicesListPage`
      info	[Changelog] - New struct `WorkloadNetworkDNSZone`
      info	[Changelog] - New struct `WorkloadNetworkDNSZoneProperties`
      info	[Changelog] - New struct `WorkloadNetworkDNSZonesList`
      info	[Changelog] - New struct `WorkloadNetworkDNSZonesListIterator`
      info	[Changelog] - New struct `WorkloadNetworkDNSZonesListPage`
      info	[Changelog] - New struct `WorkloadNetworksCreateDNSServiceFuture`
      info	[Changelog] - New struct `WorkloadNetworksCreateDNSZoneFuture`
      info	[Changelog] - New struct `WorkloadNetworksDeleteDNSServiceFuture`
      info	[Changelog] - New struct `WorkloadNetworksDeleteDNSZoneFuture`
      info	[Changelog] - New struct `WorkloadNetworksUpdateDNSServiceFuture`
      info	[Changelog] - New struct `WorkloadNetworksUpdateDNSZoneFuture`
      info	[Changelog] - New field `InternalName` in struct `MetricDimension`
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog]
      info	[Changelog] Total 11 breaking change(s), 210 additive change(s).
      info	[Changelog]
    • ️✔️avs/mgmt/2020-03-20/avs [View full logs]  [Release SDK Changes]
      info	[Changelog] ## New Content
      info	[Changelog]
      info	[Changelog] - New field `InternalName` in struct `MetricDimension`
      info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @ctaggart, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @ctaggart
    Copy link
    Contributor Author

    ctaggart commented Jan 6, 2021

    @filizt, thanks for the feedback! I added the 204 response in 0d2b704. I'd like to get ARM signoff on this, this week. I will do the internal breaking change meeting on Monday (internal work item 9068467).

    @filizt
    Copy link
    Contributor

    filizt commented Jan 7, 2021

    @ctaggart The changes in the PR looks good from ARM perspective but official sign off will wait until breaking changes board's approval.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 11, 2021
    @ctaggart
    Copy link
    Contributor Author

    @filizt & @zhenglaizhang, the breaking change has been reviewed and approved. Please approve & merge.

    @jorgecotillo jorgecotillo added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 11, 2021
    @jorgecotillo
    Copy link
    Contributor

    ARM Signed off

    @zhenglaizhang
    Copy link
    Contributor

    @msyyc @ArcturusZhang pls help take a look at python or go sdk breaking changes respectively

    @ctaggart
    Copy link
    Contributor Author

    @zhenglaizhang, we do not have any SDKs published for this API version. We do not intend to publish SDKs for this API version. We do need this merged soon.

    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    Hi @ctaggart unfortunately we have released one package of this api-version in go SDK v49.0.0 (https://github.com/Azure/azure-sdk-for-go/tree/v49.0.0/services/preview/avs/mgmt/2020-07-17-preview/avs).
    If we did not want to release one package, we should not include this package in readme.go.md (this was added in this PR #10866). Could you please remove it from readme.go.md?
    Considering that this package is a preview package, it is OK to remove it. But I suggest you double confirm about this.

    @ctaggart
    Copy link
    Contributor Author

    Hey @ArcturusZhang, in that case, I'm okay with releasing the go SDK with these changes.

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    The breaking changes introduced in this PR are relative minor and considering those happen on a preview package, therefore those are acceptable

    @msyyc
    Copy link
    Member

    msyyc commented Jan 13, 2021

    @msyyc Yuchao Yan FTE @ArcturusZhang Dapeng Zhang FTE pls help take a look at python or go sdk breaking changes respectively

    It's ok for Python

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-Python
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants