asm: update examples to use asm- prefix for revisions #25248

SanyaKochhar · 2023-08-09T21:50:19Z

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

[1] public repo review queue, private repo review queue
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix swagger quality issues in S360.
Other, please clarify:
- Update existing version to fix formatting in the example output for mesh operations. In our charts, we use "asm-x-y" for the revisions field, but the examples show "x-y". Updating these for alignment. The operations for these routes will return "asm-x-y" as well.

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.

Breaking changes review (Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason.
  Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

If this PR is in purview of ARM review then automation will add the ARMReview label.
If you want to force ARM review, add the label yourself.
Proceed according to the diagram at the top of this comment.

Getting help

For general PR approval workflow, see the diagram at the top of this comment.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2023-08-09T21:50:22Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2023-08-09T21:50:22Z

Hi @SanyaKochhar, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO.

You can refer to Service API Toolset Introduction for details.

Please contact service focal contacts or Service API Toolset Support Channel if need further help.

openapi-pipeline-app · 2023-08-09T21:50:23Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from e9325d6. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.6.7 -> 9.8.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.8.1` to update!
cmderr	[automation_generate.sh] npm notice
warn	No file changes detected after generation
warn	No package detected after generation

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from e9325d6. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-containerservicemicrosoftcontainerserviceaks-generated [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e9325d6. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/containerservice/armcontainerservice [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New enum type `NodeOSUpgradeChannel` with values `NodeOSUpgradeChannelNodeImage`, `NodeOSUpgradeChannelNone`, `NodeOSUpgradeChannelUnmanaged`
info	[Changelog] - New struct `ClusterUpgradeSettings`
info	[Changelog] - New struct `DelegatedResource`
info	[Changelog] - New struct `ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler`
info	[Changelog] - New struct `UpgradeOverrideSettings`
info	[Changelog] - New field `DrainTimeoutInMinutes` in struct `AgentPoolUpgradeSettings`
info	[Changelog] - New field `NodeOSUpgradeChannel` in struct `ManagedClusterAutoUpgradeProfile`
info	[Changelog] - New field `DelegatedResources` in struct `ManagedClusterIdentity`
info	[Changelog] - New field `UpgradeSettings` in struct `ManagedClusterProperties`
info	[Changelog] - New field `VerticalPodAutoscaler` in struct `ManagedClusterWorkloadAutoScalerProfile`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 17 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e9325d6. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-containerservice [View full logs] [Release SDK Changes]

azure-arm-containerservice-19.3.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface ClusterUpgradeSettings
info	[Changelog]   - Added Interface UpgradeOverrideSettings
info	[Changelog]   - Interface ManagedCluster has a new optional parameter upgradeSettings

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e9325d6. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.ContainerService [View full logs] [Release SDK Changes]
- Azure.ResourceManager.ContainerService.1.2.0-alpha.20230817.1.nupkg
```
info	[Changelog]
```

️❌ azure-resource-manager-schemas failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from e9325d6. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation
cannot force update branch 'sdkAuto/containerservice' as it is the current HEAD of the repository.
Error: cannot force update branch 'sdkAuto/containerservice' as it is the current HEAD of the repository.

️✔️containerservice [View full logs]

️✔️containerservice [View full logs]

error	Fatal error: cannot force update branch 'sdkAuto/containerservice' as it is the current HEAD of the repository.
error	The following packages are still pending:
error		containerservice
error		containerservice

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from e9325d6. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.containerservice.DefaultTag [View full logs]

Az.ContainerService.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.containerservice.DefaultTag

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-08-09T21:50:24Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/containerservice/armcontainerservice	https://apiview.dev/Assemblies/Review/2742c4e88b9d45779a28bb3961e7fe5b
Java	azure-resourcemanager-containerservicemicrosoftcontainerserviceaks-generated	https://apiview.dev/Assemblies/Review/8618ce8c84a7490f8be5e4a1a74930df
.Net	Azure.ResourceManager.ContainerService	There is no API change compared with the previous version
JavaScript	@azure/arm-containerservice	https://apiview.dev/Assemblies/Review/b25b46892e2a4c039e43895bd1ffb512

openapi-workflow-bot · 2023-08-09T21:50:25Z

Hi, @SanyaKochhar! Thank you for your pull request. To help get your PR merged:

Ensure you reviewed the checklists in the PR description.

Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

FumingZhang · 2023-08-10T02:32:14Z

/azp run

azure-pipelines · 2023-08-10T02:32:26Z

Azure Pipelines successfully started running 2 pipeline(s).

SanyaKochhar · 2023-08-15T18:26:26Z

/azp run

azure-pipelines · 2023-08-15T19:18:10Z

Commenter does not have sufficient privileges for PR 25248 in repo Azure/azure-rest-api-specs

FumingZhang · 2023-08-16T23:40:25Z

/azp run

openapi-pipeline-app · 2023-08-16T23:40:28Z

Next Steps to Merge

⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

azure-pipelines · 2023-08-16T23:40:36Z

Azure Pipelines successfully started running 2 pipeline(s).

openapi-pipeline-app · 2023-08-17T00:21:51Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

asm: update examples to use asm- prefix for revisions

3558281

SanyaKochhar requested review from palma21, weinong, alvinli222, matthchr and circy9 as code owners August 9, 2023 21:50

openapi-assignment-bot bot assigned rkmanda Aug 9, 2023

openapi-workflow-bot bot added the ShiftLeftViolation label Aug 9, 2023

openapi-workflow-bot bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Aug 9, 2023

AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 9, 2023

ms-zhenhua 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 Aug 10, 2023

FumingZhang removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Aug 16, 2023

openapi-pipeline-app bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Aug 16, 2023

rkmanda removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Aug 17, 2023

rkmanda approved these changes Aug 17, 2023

View reviewed changes

rkmanda merged commit e9325d6 into Azure:main Aug 17, 2023
28 of 30 checks passed

openapi-pipeline-app bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Aug 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

asm: update examples to use asm- prefix for revisions #25248

asm: update examples to use asm- prefix for revisions #25248

SanyaKochhar commented Aug 9, 2023

openapi-pipeline-app bot commented Aug 9, 2023 •

edited

Loading

openapi-workflow-bot bot commented Aug 9, 2023

openapi-pipeline-app bot commented Aug 9, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 9, 2023 •

edited

Loading

openapi-workflow-bot bot commented Aug 9, 2023

FumingZhang commented Aug 10, 2023

azure-pipelines bot commented Aug 10, 2023

SanyaKochhar commented Aug 15, 2023

azure-pipelines bot commented Aug 15, 2023

FumingZhang commented Aug 16, 2023

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

azure-pipelines bot commented Aug 16, 2023

openapi-pipeline-app bot commented Aug 17, 2023

asm: update examples to use asm- prefix for revisions #25248

asm: update examples to use asm- prefix for revisions #25248

Conversation

SanyaKochhar commented Aug 9, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Breaking changes review (Step 1)

ARM API changes review (Step 2)

Getting help

openapi-pipeline-app bot commented Aug 9, 2023 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Aug 9, 2023

openapi-pipeline-app bot commented Aug 9, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 9, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Aug 9, 2023

FumingZhang commented Aug 10, 2023

azure-pipelines bot commented Aug 10, 2023

SanyaKochhar commented Aug 15, 2023

azure-pipelines bot commented Aug 15, 2023

FumingZhang commented Aug 16, 2023

openapi-pipeline-app bot commented Aug 16, 2023 • edited Loading

Next Steps to Merge

azure-pipelines bot commented Aug 16, 2023

openapi-pipeline-app bot commented Aug 17, 2023

openapi-pipeline-app bot commented Aug 9, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 9, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 9, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading