Update readme.go.md #26140

kenieva · 2023-10-09T18:50:47Z

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] ARM review queue (for merge queues, see [4])
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 (for ARM review queue, [1])

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:
- edit this with your clarification

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.

Viewing API changes

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.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

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-10-09T18:50:51Z

Next Steps to Merge

✔️ 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).

openapi-pipeline-app · 2023-10-09T18:50:51Z

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.

compared tags (via openapi-validator v2.1.6)	new version	base version
default	default(3a4a9ed)	default(main)

️️✔️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-pipeline-app · 2023-10-09T18:50:52Z

Swagger Generation Artifacts

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

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

Breaking Changes Tracking

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

⚠️Warning [Logs]Release - Generate from 40050a3. 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
warn	No file changes detected after generation

️✔️Azure.ResourceManager.Resources [View full logs]
- Azure.ResourceManager.Resources.1.7.0-alpha.20231012.1.nupkg
```
info	[Changelog]
```

️❌ azure-sdk-for-python-track2 failed [Detail]

❌Code Generator Failed [Logs]Release - Generate from 40050a3. 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]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.0` to update!
cmderr	[automation_generate.sh] npm notice
cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

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

⚠️Warning [Logs]Release - Generate from 40050a3. 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-resources-generated [View full logs] [Release SDK Changes]

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

️✔️Succeeded [Logs]Release - Generate from 40050a3. 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/resources/armresources [View full logs] [Release SDK Changes] Breaking Change Detected

Only show 11 items here, please refer to log for details.

info	[Changelog] - Operation `*TagsClient.CreateOrUpdateAtScope` has been changed to LRO, use `*TagsClient.BeginCreateOrUpdateAtScope` instead.
info	[Changelog] - Operation `*TagsClient.DeleteAtScope` has been changed to LRO, use `*TagsClient.BeginDeleteAtScope` instead.
info	[Changelog] - Operation `*TagsClient.UpdateAtScope` has been changed to LRO, use `*TagsClient.BeginUpdateAtScope` instead.
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New struct `DeploymentParameter`
info	[Changelog] - New struct `KeyVaultParameterReference`
info	[Changelog] - New struct `KeyVaultReference`
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 6 additive change(s).

️✔️sdk/resourcemanager/resources/armdeploymentscripts [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New struct `ContainerGroupSubnetID`
info	[Changelog] - New field `SubnetIDs` in struct `ContainerConfiguration`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 3 additive change(s).

️✔️sdk/resourcemanager/resources/armfeatures [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️sdk/resourcemanager/resources/armlinks [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️sdk/resourcemanager/resources/armlocks [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️sdk/resourcemanager/resources/armmanagedapplications [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️sdk/resourcemanager/resources/armpolicy [View full logs] [Release SDK Changes] Breaking Change Detected

Only show 11 items here, please refer to log for details.

info	[Changelog] - New struct `VariableValueColumnValue`
info	[Changelog] - New struct `VariableValueListResult`
info	[Changelog] - New struct `VariableValueProperties`
info	[Changelog] - New field `Overrides`, `ResourceSelectors` in struct `AssignmentProperties`
info	[Changelog] - New field `Properties` in struct `AssignmentUpdate`
info	[Changelog] - New field `Version`, `Versions` in struct `DefinitionProperties`
info	[Changelog] - New field `AssignmentScopeValidation`, `ResourceSelectors` in struct `ExemptionProperties`
info	[Changelog] - New field `Schema` in struct `ParameterDefinitionsValue`
info	[Changelog] - New field `Version`, `Versions` in struct `SetDefinitionProperties`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 107 additive change(s).

️✔️sdk/resourcemanager/resources/armsubscriptions [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️sdk/resourcemanager/resources/armtemplatespecs [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️sdk/resourcemanager/resources/armchanges [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️sdk/resourcemanager/resources/armdeploymentstacks [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️🔄 azure-sdk-for-js inProgress [Detail]

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

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

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  notice
cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.0` to update!
cmderr	[initScript.sh] npm notice
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
cannot force update branch 'sdkAuto/resources' as it is the current HEAD of the repository.
Error: cannot force update branch 'sdkAuto/resources' as it is the current HEAD of the repository.

️✔️resources [View full logs] [Release Schema Changes]

️✔️resources [View full logs]

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

️✔️resources
️✔️resources

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from 40050a3. 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.resources.DefaultTag [View full logs]

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

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

openapi-pipeline-app · 2023-10-09T18:50:53Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/resources/armchanges	There is no API change compared with the previous version
Go	sdk/resourcemanager/resources/armdeploymentscripts	https://apiview.dev/Assemblies/Review/5e59b5e62bcf4cad899edfa0ac4c0833
Go	sdk/resourcemanager/resources/armdeploymentstacks	There is no API change compared with the previous version
Go	sdk/resourcemanager/resources/armfeatures	There is no API change compared with the previous version
Java	azure-resourcemanager-resources-generated	https://apiview.dev/Assemblies/Review/d3490dba34c04ac9bb031d39b62118d1
Go	sdk/resourcemanager/resources/armlinks	There is no API change compared with the previous version
Go	sdk/resourcemanager/resources/armlocks	There is no API change compared with the previous version
Go	sdk/resourcemanager/resources/armmanagedapplications	There is no API change compared with the previous version
Go	sdk/resourcemanager/resources/armpolicy	https://apiview.dev/Assemblies/Review/d96a5e6fa854482db147ce697d4d6cd0
Go	sdk/resourcemanager/resources/armresources	https://apiview.dev/Assemblies/Review/1ce789d4a40c4a29ae056c892bf55340
Go	sdk/resourcemanager/resources/armsubscriptions	There is no API change compared with the previous version
Go	sdk/resourcemanager/resources/armtemplatespecs	There is no API change compared with the previous version
.Net	Azure.ResourceManager.Resources	There is no API change compared with the previous version

kenieva · 2023-10-10T16:03:48Z

@tadelesh - is there anything missing here before review? We are working a time crunch for Ignite. We need the tag added to be able to generate the new GO SDK.

kenieva · 2023-10-12T16:52:58Z

/pr RequestMerge

openapi-pipeline-app · 2023-10-12T18:04:56Z

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

Update readme.go.md

3a4a9ed

kenieva requested a review from tadelesh as a code owner October 9, 2023 18:50

openapi-assignment-bot bot assigned rkmanda Oct 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 Oct 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 Oct 12, 2023

github-actions bot added the MergeRequested label Oct 12, 2023

rkmanda approved these changes Oct 12, 2023

View reviewed changes

rkmanda merged commit 40050a3 into main Oct 12, 2023
26 of 31 checks passed

rkmanda deleted the kenieva-patch-1 branch October 12, 2023 18:04

openapi-pipeline-app bot added the CI-BreakingChange-Go label Oct 12, 2023

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023

Update readme.go.md (#26140)

49755fb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme.go.md #26140

Update readme.go.md #26140

kenieva commented Oct 9, 2023 •

edited by openapi-workflow-bot bot

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading

Breaking Changes Tracking

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

edited

Loading

kenieva commented Oct 10, 2023

kenieva commented Oct 12, 2023

openapi-pipeline-app bot commented Oct 12, 2023

Update readme.go.md #26140

Update readme.go.md #26140

Conversation

kenieva commented Oct 9, 2023 • edited by openapi-workflow-bot bot Loading

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)

Viewing API changes

Suppressing failures

Getting help

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

Next Steps to Merge

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

Swagger Validation Report

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

Swagger Generation Artifacts

Breaking Changes Tracking

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

Generated ApiView

kenieva commented Oct 10, 2023

kenieva commented Oct 12, 2023

openapi-pipeline-app bot commented Oct 12, 2023

kenieva commented Oct 9, 2023 •

edited by openapi-workflow-bot bot

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading