Update python & java readmes for ContainerService/aks 2023-11-01 by FumingZhang · Pull Request #26752 · Azure/azure-rest-api-specs

FumingZhang · 2023-11-17T02:37:42Z

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. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
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-11-17T02:37:46Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ Your PR has breaking changes in the generated SDK for python (label: CI-BreakingChange-Python-Track2). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app · 2023-11-17T02:37:46Z

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

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

Validation passes for LintDiff.

compared tags (via openapi-validator v2.1.6)	new version	base version
default	default(34a00db)	default(dev-containerservice-Microsoft.ContainerService-2023-11-01)

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

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️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-11-17T02:37:47Z

Swagger Generation Artifacts

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

️⚠️SDK Breaking Change Tracking warning [Detail]

Breaking Changes Tracking

⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-containerservice - 27.0.0

+	Renamed operation TrustedAccessRoleBindingsOperations.create_or_update to TrustedAccessRoleBindingsOperations.begin_create_or_update
+	Renamed operation TrustedAccessRoleBindingsOperations.delete to TrustedAccessRoleBindingsOperations.begin_delete

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

⚠️Warning [Logs] Generate from 577a492ba5989a268a6a0d0f5d0d5aa27fc4416a. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
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.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.4` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-containerservice [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group OperationStatusResultOperations
info	[Changelog]   - Model AgentPool has a new parameter capacity_reservation_group_id
info	[Changelog]   - Model AgentPool has a new parameter network_profile
info	[Changelog]   - Model ManagedClusterAgentPoolProfile has a new parameter capacity_reservation_group_id
info	[Changelog]   - Model ManagedClusterAgentPoolProfile has a new parameter network_profile
info	[Changelog]   - Model ManagedClusterAgentPoolProfileProperties has a new parameter capacity_reservation_group_id
info	[Changelog]   - Model ManagedClusterAgentPoolProfileProperties has a new parameter network_profile
info	[Changelog]   - Model ManagedClusterLoadBalancerProfile has a new parameter backend_pool_type
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Renamed operation TrustedAccessRoleBindingsOperations.create_or_update to TrustedAccessRoleBindingsOperations.begin_create_or_update
info	[Changelog]   - Renamed operation TrustedAccessRoleBindingsOperations.delete to TrustedAccessRoleBindingsOperations.begin_delete

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

⚠️Warning [Logs] Generate from 577a492ba5989a268a6a0d0f5d0d5aa27fc4416a. 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.3.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.3.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] [Preview SDK Changes]

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

️✔️Succeeded [Logs] Generate from 577a492ba5989a268a6a0d0f5d0d5aa27fc4416a. 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] [Preview SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New enum type `BackendPoolType` with values `BackendPoolTypeNodeIP`, `BackendPoolTypeNodeIPConfiguration`
info	[Changelog] - New enum type `Protocol` with values `ProtocolTCP`, `ProtocolUDP`
info	[Changelog] - New enum type `TrustedAccessRoleBindingProvisioningState` with values `TrustedAccessRoleBindingProvisioningStateCanceled`, `TrustedAccessRoleBindingProvisioningStateDeleting`, `TrustedAccessRoleBindingProvisioningStateFailed`, `TrustedAccessRoleBindingProvisioningStateSucceeded`, `TrustedAccessRoleBindingProvisioningStateUpdating`
info	[Changelog] - New function `*ClientFactory.NewTrustedAccessRoleBindingsClient() *TrustedAccessRoleBindingsClient`
info	[Changelog] - New function `*ClientFactory.NewTrustedAccessRolesClient() *TrustedAccessRolesClient`
info	[Changelog] - New function `NewTrustedAccessRoleBindingsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*TrustedAccessRoleBindingsClient, error)`
info	[Changelog] - New function `*TrustedAccessRoleBindingsClient.BeginCreateOrUpdate(context.Context, string, string, string, TrustedAccessRoleBinding, *TrustedAccessRoleBindingsClientBeginCreateOrUpdateOptions) (*runtime.Poller[TrustedAccessRoleBindingsClientCreateOrUpdateResponse], error)`
info	[Changelog] - New function `*TrustedAccessRoleBindingsClient.BeginDelete(context.Context, string, string, string, *TrustedAccessRoleBindingsClientBeginDeleteOptions) (*runtime.Poller[TrustedAccessRoleBindingsClientDeleteResponse], error)`
info	[Changelog] - New function `*TrustedAccessRoleBindingsClient.Get(context.Context, string, string, string, *TrustedAccessRoleBindingsClientGetOptions) (TrustedAccessRoleBindingsClientGetResponse, error)`
info	[Changelog] - New function `*TrustedAccessRoleBindingsClient.NewListPager(string, string, *TrustedAccessRoleBindingsClientListOptions) *runtime.Pager[TrustedAccessRoleBindingsClientListResponse]`
info	[Changelog] - New function `NewTrustedAccessRolesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*TrustedAccessRolesClient, error)`
info	[Changelog] - New function `*TrustedAccessRolesClient.NewListPager(string, *TrustedAccessRolesClientListOptions) *runtime.Pager[TrustedAccessRolesClientListResponse]`
info	[Changelog] - New struct `AgentPoolNetworkProfile`
info	[Changelog] - New struct `IPTag`
info	[Changelog] - New struct `PortRange`
info	[Changelog] - New struct `TrustedAccessRole`
info	[Changelog] - New struct `TrustedAccessRoleBinding`
info	[Changelog] - New struct `TrustedAccessRoleBindingListResult`
info	[Changelog] - New struct `TrustedAccessRoleBindingProperties`
info	[Changelog] - New struct `TrustedAccessRoleListResult`
info	[Changelog] - New struct `TrustedAccessRoleRule`
info	[Changelog] - New field `CapacityReservationGroupID`, `NetworkProfile` in struct `ManagedClusterAgentPoolProfile`
info	[Changelog] - New field `CapacityReservationGroupID`, `NetworkProfile` in struct `ManagedClusterAgentPoolProfileProperties`
info	[Changelog] - New field `BackendPoolType` in struct `ManagedClusterLoadBalancerProfile`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 42 additive change(s).

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

️✔️Succeeded [Logs] Generate from 577a492ba5989a268a6a0d0f5d0d5aa27fc4416a. 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] [Preview SDK Changes]

azure-arm-containerservice-19.5.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group TrustedAccessRoleBindings
info	[Changelog]   - Added operation group TrustedAccessRoles
info	[Changelog]   - Added Interface AgentPoolNetworkProfile
info	[Changelog]   - Added Interface ErrorAdditionalInfo
info	[Changelog]   - Added Interface ErrorDetail
info	[Changelog]   - Added Interface ErrorResponse
info	[Changelog]   - Added Interface IPTag
info	[Changelog]   - Added Interface PortRange
info	[Changelog]   - Added Interface TrustedAccessRole
info	[Changelog]   - Added Interface TrustedAccessRoleBinding
info	[Changelog]   - Added Interface TrustedAccessRoleBindingListResult
info	[Changelog]   - Added Interface TrustedAccessRoleBindingsCreateOrUpdateOptionalParams
info	[Changelog]   - Added Interface TrustedAccessRoleBindingsDeleteHeaders
info	[Changelog]   - Added Interface TrustedAccessRoleBindingsDeleteOptionalParams
info	[Changelog]   - Added Interface TrustedAccessRoleBindingsGetOptionalParams
info	[Changelog]   - Added Interface TrustedAccessRoleBindingsListNextOptionalParams
info	[Changelog]   - Added Interface TrustedAccessRoleBindingsListOptionalParams
info	[Changelog]   - Added Interface TrustedAccessRoleListResult
info	[Changelog]   - Added Interface TrustedAccessRoleRule
info	[Changelog]   - Added Interface TrustedAccessRolesListNextOptionalParams
info	[Changelog]   - Added Interface TrustedAccessRolesListOptionalParams
info	[Changelog]   - Added Type Alias BackendPoolType
info	[Changelog]   - Added Type Alias Protocol
info	[Changelog]   - Added Type Alias TrustedAccessRoleBindingProvisioningState
info	[Changelog]   - Added Type Alias TrustedAccessRoleBindingsCreateOrUpdateResponse
info	[Changelog]   - Added Type Alias TrustedAccessRoleBindingsDeleteResponse
info	[Changelog]   - Added Type Alias TrustedAccessRoleBindingsGetResponse
info	[Changelog]   - Added Type Alias TrustedAccessRoleBindingsListNextResponse
info	[Changelog]   - Added Type Alias TrustedAccessRoleBindingsListResponse
info	[Changelog]   - Added Type Alias TrustedAccessRolesListNextResponse
info	[Changelog]   - Added Type Alias TrustedAccessRolesListResponse
info	[Changelog]   - Interface AgentPool has a new optional parameter capacityReservationGroupID
info	[Changelog]   - Interface AgentPool has a new optional parameter networkProfile
info	[Changelog]   - Interface ManagedClusterAgentPoolProfileProperties has a new optional parameter capacityReservationGroupID
info	[Changelog]   - Interface ManagedClusterAgentPoolProfileProperties has a new optional parameter networkProfile
info	[Changelog]   - Interface ManagedClusterLoadBalancerProfile has a new optional parameter backendPoolType
info	[Changelog]   - Added Enum KnownBackendPoolType
info	[Changelog]   - Added Enum KnownProtocol
info	[Changelog]   - Added Enum KnownTrustedAccessRoleBindingProvisioningState

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

️✔️Succeeded [Logs] Generate from 577a492ba5989a268a6a0d0f5d0d5aa27fc4416a. 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] [Preview SDK Changes]
- Azure.ResourceManager.ContainerService.1.2.0-alpha.20231117.1.nupkg
```
info	[Changelog]
```

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

❌Pipeline Framework Failed [Logs] Generate from 577a492ba5989a268a6a0d0f5d0d5aa27fc4416a. 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] npm notice
cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.4
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.4` 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
warn	No file changes detected after generation
cannot force update branch 'sdkAuto/26752/containerservice' as it is the current HEAD of the repository.
Error: cannot force update branch 'sdkAuto/26752/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/26752/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] Generate from 577a492ba5989a268a6a0d0f5d0d5aa27fc4416a. 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]

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-11-17T02:37:48Z

Generated ApiView

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

update readme

34a00db

FumingZhang requested review from alvinli222, circy9, matthchr, msyyc, palma21 and weinong as code owners November 17, 2023 02:37

FumingZhang changed the title ~~Update python & java readmes for ContainerService/aks 2023-10-01~~ Update python & java readmes for ContainerService/aks 2023-11-01 Nov 17, 2023

azure-sdk mentioned this pull request Nov 17, 2023

[AutoPR sdk/resourcemanager/containerservice/armcontainerservice] Update python & java readmes for ContainerService/aks 2023-11-01 azure-sdk/azure-sdk-for-go#8248

Closed

AzureRestAPISpecReview added the resource-manager label Nov 17, 2023

FumingZhang enabled auto-merge (squash) November 17, 2023 02:44

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Nov 17, 2023

microsoft-github-policy-service bot added no-recent-activity and removed no-recent-activity labels Dec 4, 2023

palma21 approved these changes Dec 8, 2023

View reviewed changes

FumingZhang merged commit ea6e916 into Azure:dev-containerservice-Microsoft.ContainerService-2023-11-01 Dec 8, 2023

FumingZhang deleted the fuming/aks-update-readme-2023-11-01 branch February 4, 2024 05:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update python & java readmes for ContainerService/aks 2023-11-01#26752

Update python & java readmes for ContainerService/aks 2023-11-01#26752
FumingZhang merged 1 commit intoAzure:dev-containerservice-Microsoft.ContainerService-2023-11-01from
FumingZhang:fuming/aks-update-readme-2023-11-01

FumingZhang commented Nov 17, 2023

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

FumingZhang commented Nov 17, 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)

Viewing API changes

Suppressing failures

Getting help

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 17, 2023 •

edited

Loading