ARM (Control Plane) API Specification Update Pull Request

[!TIP] Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

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

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

[ ] New resource provider.
[x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
[ ] 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 OpenAPI spec 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:

[x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
[x] 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 the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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 suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
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.

Jun 21 '24 02:06 FumingZhang

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Jun 21 '24 02:06 openapi-pipeline-app[bot]

Swagger Validation Report

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

There are no breaking changes.

️❌Breaking Change(Cross-Version): 1 Errors, 142 Warnings failed [Detail]

Compared specs (v0.10.12)	new version	base version
managedClusters.json	2024-05-01(3e9f9ff)	2024-02-01(main)
managedClusters.json	2024-05-01(3e9f9ff)	2024-04-02-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default' removed or restructured? Old: aks/stable/2024-02-01/managedClusters.json#L73:5

The following breaking changes are detected by comparison with the latest preview version:

Only 30 items are listed, please refer to log for more details.

Rule	Message
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L73:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L1410:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L1468:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L1516:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L2528:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations/{operationId}' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L2573:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/operations/{operationId}' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L2618:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L2933:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L2972:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3014:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions/{version}' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3441:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3484:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions/{version}' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3527:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3570:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3789:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rebalanceLoadBalancers' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3834:5
:warning: 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers/{loadBalancerName}' removed or restructured? Old: aks/preview/2024-04-02-preview/managedClusters.json#L3889:5
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'VirtualMachinesProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ScaleProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'VirtualMachineNodesStatus' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'PodLinkLocalAccess' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ManagedClusterNodeResourceGroupProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ManagedClusterStaticEgressGatewayProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'PodIPAllocationMode' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AgentPoolSecurityProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AgentPoolGPUProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AgentPoolArtifactStreamingProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AgentPoolSSHAccess' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AgentPoolGatewayProfile' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3
:warning: 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileImageIntegrity' removed or renamed? New: aks/stable/2024-05-01/managedClusters.json#L2921:3 Old: aks/preview/2024-04-02-preview/managedClusters.json#L4045:3

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-2024-05	package-2024-05(3e9f9ff)	default(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/stable/2024-05-01/managedClusters.json#L52
`❌` OperationsApiSchemaUsesCommonTypes	Operations API path must follow the schema provided in the common types. Location: aks/stable/2024-05-01/managedClusters.json#L53
`❌` XmsPageableForListCalls	`x-ms-pageable` extension must be specified for LIST APIs. Location: aks/stable/2024-05-01/managedClusters.json#L74
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: aks/stable/2024-05-01/managedClusters.json#L95
`❌` ResourceNameRestriction	The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/stable/2024-05-01/managedClusters.json#L236
`❌` ParametersInPost	server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2024-05-01/managedClusters.json#L294
`❌` ParametersInPost	server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2024-05-01/managedClusters.json#L339
`❌` ParametersInPost	format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2024-05-01/managedClusters.json#L339
`❌` ParametersInPost	server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2024-05-01/managedClusters.json#L387
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L511
`❌` PatchResponseCodes	Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: aks/stable/2024-05-01/managedClusters.json#L600
`❌` PatchIdentityProperty	The patch operation body parameter schema should contain property 'identity'. Location: aks/stable/2024-05-01/managedClusters.json#L619
`❌` LroPatch202	The async patch operation should return 202. Location: aks/stable/2024-05-01/managedClusters.json#L629
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L639
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L686
`❌` ResourceNameRestriction	The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/stable/2024-05-01/managedClusters.json#L746
`❌` PostResponseCodes	Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: aks/stable/2024-05-01/managedClusters.json#L916
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L960
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L1112
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L1216
`❌` XmsPageableForListCalls	`x-ms-pageable` extension must be specified for LIST APIs. Location: aks/stable/2024-05-01/managedClusters.json#L1274
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: aks/stable/2024-05-01/managedClusters.json#L1278
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: aks/stable/2024-05-01/managedClusters.json#L1298
`❌` PostResponseCodes	200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: aks/stable/2024-05-01/managedClusters.json#L1317
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L1363
`❌` PostResponseCodes	200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: aks/stable/2024-05-01/managedClusters.json#L1379
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L1426
`❌` PostResponseCodes	Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: aks/stable/2024-05-01/managedClusters.json#L1442
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2024-05-01/managedClusters.json#L1479
`❌` PostResponseCodes	Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: aks/stable/2024-05-01/managedClusters.json#L1495

️❌Avocado: 9 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/providers/Microsoft.ContainerService/containerServices` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2017-07-01/containerService.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/containerServices/{}` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2017-07-01/containerService.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/containerServices` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2017-07-01/containerService.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/managedClusters/{}/accessProfiles/{}` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2017-08-31/managedClusters.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/providers/Microsoft.ContainerService/locations/{}/orchestrators` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2019-08-01/location.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/providers/Microsoft.ContainerService/openShiftManagedClusters` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2019-04-30/openShiftManagedClusters.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/openShiftManagedClusters` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2019-04-30/openShiftManagedClusters.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/openShiftManagedClusters/{}` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2019-04-30/openShiftManagedClusters.json
`❌` MISSING_APIS_IN_DEFAULT_TAG	The default tag should contain all APIs. The API path `/subscriptions/{}/providers/Microsoft.ContainerService/locations/{}/osOptions/default` is not in the default tag. Please make sure the missing API swaggers are in the default tag. readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/stable/2024-02-01/managedClusters.json

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

️️✔️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?}

Jun 21 '24 02:06 openapi-pipeline-app[bot]

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` RestBuild error	"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=436905&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 "

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

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

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

FAQ

️✔️Succeeded in generating from 2719c03411d111d503bb4fd6caca9e7bdeb68831. 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 [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*ManagedClustersClient.GetOSOptions` has been removed
info	[Changelog] - Struct `OSOptionProfile` has been removed
info	[Changelog] - Struct `OSOptionProperty` has been removed
info	[Changelog] - Struct `OSOptionPropertyList` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `NetworkPolicyNone` added to enum type `NetworkPolicy`
info	[Changelog] - New value `NodeOSUpgradeChannelSecurityPatch` added to enum type `NodeOSUpgradeChannel`
info	[Changelog] - New field `DaemonsetEvictionForEmptyNodes`, `DaemonsetEvictionForOccupiedNodes`, `IgnoreDaemonsetsUtilization` in struct `ManagedClusterPropertiesAutoScalerProfile`
info	[Changelog]
info	[Changelog] Total 7 breaking change(s), 3 additive change(s).

Present SDK breaking changes suppressions
Function `*ManagedClustersClient.GetOSOptions` has been removed
Struct `OSOptionProfile` has been removed
Struct `OSOptionPropertyList` has been removed
Struct `OSOptionProperty` has been removed

Please refer to the guidance for suppressing SDK breaking changes.

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

FAQ

️✔️Succeeded in generating from 2719c03411d111d503bb4fd6caca9e7bdeb68831. 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	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-containerservice [Preview SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Interface ManagedClusterPropertiesAutoScalerProfile has a new optional parameter daemonsetEvictionForEmptyNodes
info	[Changelog]   - Interface ManagedClusterPropertiesAutoScalerProfile has a new optional parameter daemonsetEvictionForOccupiedNodes
info	[Changelog]   - Interface ManagedClusterPropertiesAutoScalerProfile has a new optional parameter ignoreDaemonsetsUtilization
info	[Changelog]   - Enum KnownNetworkPolicy has a new value None
info	[Changelog]   - Enum KnownNodeOSUpgradeChannel has a new value SecurityPatch
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Removed operation ManagedClusters.getOSOptions

Present SDK breaking changes suppressions
Removed operation ManagedClusters.getOSOptions

Please refer to the guidance for suppressing SDK breaking changes.

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

FAQ

❌Pipeline Framework Failed in generating from 2719c03411d111d503bb4fd6caca9e7bdeb68831. 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
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to build project. exit code: False
error	FatalError: ConfigError: Invalid GenerateOutput: .packages[0].installInstructions should be object. Please refer to the schema definitions at https://github.com/Azure/azure-rest-api-specs/tree/main/documentation/sdkautomation to fix the configuration issue.. Please refer to the inner logs for details or report this issue through https://aka.ms/azsdk/support/specreview-channel.
ConfigError: Invalid GenerateOutput: .packages[0].installInstructions should be object. Please refer to the schema definitions at https://github.com/Azure/azure-rest-api-specs/tree/main/documentation/sdkautomation to fix the configuration issue.
error	ErrorStack: Error: ConfigError: Invalid GenerateOutput: .packages[0].installInstructions should be object. Please refer to the schema definitions at https://github.com/Azure/azure-rest-api-specs/tree/main/documentation/sdkautomation to fix the configuration issue.    at /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/types/validator.js:32:19    at workflowCallGenerateScript (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:605:69)    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)    at async workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:239:40)    at async workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:107:9)    at async sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:199:13)    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18.

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

FAQ

❌Code Generator Failed in generating from 2719c03411d111d503bb4fd6caca9e7bdeb68831. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
cmderr	[initScript.sh] npm notice
cmderr	[initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
cmderr	[initScript.sh] npm notice To update run: npm install -g [email protected]
cmderr	[initScript.sh] npm notice
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
warn	Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500
cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
cmderr	[generateScript.sh]            ^
cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12)
cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19)
cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36)
cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32)
cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43)
cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12)
cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.

️️✔️ azure-powershell succeeded [Detail] [Expand]

FAQ

️✔️Succeeded in generating from 2719c03411d111d503bb4fd6caca9e7bdeb68831. 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

️✔️Az.containerservice.DefaultTag [Preview SDK Changes]

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

Jun 21 '24 02:06 openapi-pipeline-app[bot]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/containerservice/armcontainerservice	https://apiview.dev/Assemblies/Review/2f19cca64456411e9c342082a432418f?revisionId=a91ec2e02e9c48f093a9b17223264d9a
JavaScript	@azure/arm-containerservice	https://apiview.dev/Assemblies/Review/dabf043916d14dc38e0c2d456d89f55a?revisionId=db5e6c719b704153af1a3f47c6908263
Swagger	Microsoft.ContainerService	https://apiview.dev/Assemblies/Review/71d5cd3d2d1c46b59eabc692899ea0b4?revisionId=b1b9509e8fe14ee4858a7584fa260e4f

Jun 21 '24 02:06 openapi-pipeline-app[bot]

/azp run

Jun 25 '24 02:06 FumingZhang

Azure Pipelines successfully started running 4 pipeline(s).

Jun 25 '24 02:06 azure-pipelines[bot]

For failed CI Swagger Avocado, only the last one is introduced in this new API version, locations/{}/osOptions/default is exactly the API path that is going to be deprecated and has received breaking change approval.

The rest already existed in the past (e.g., 2023-05-01),

aks/stable/2017-07-01/containerService.json, which is deprecated and replaced by AKS (managedClusters).
aks/stable/2017-08-31/managedClusters.json, the missing API (.../managedClusters/{}/accessProfiles/{}) is deprecated and replaced by ListClusterUserCredentials or ListClusterAdminCredentials according to the need.
aks/stable/2019-08-01/location.json, the missing API (.../locations/{}/orchestrators) is deprecated, and has been replaced by a new API /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions in 2023-03-01 and 2023-03-02-preview.
aks/stable/2019-04-30/openShiftManagedClusters.json, which is deprecated and replaced by redhatopenshift.

Jun 25 '24 03:06 FumingZhang

Please confirm that https://eng.ms/docs/products/arm/rpaas/decommissioning/resource_type_deprecation is followed for removing the "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default" API

Jun 25 '24 20:06 ramoka178

Please confirm that https://eng.ms/docs/products/arm/rpaas/decommissioning/resource_type_deprecation is followed for removing the "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default" API

Hey @ramoka178, we are not completely removing this resource type locations/osOptions, instead we are simply no longer supporting it in API versions starting with 2024-05-01 and I think this wiki may not be applicable.

Jun 26 '24 02:06 FumingZhang

/azp run

Jun 29 '24 01:06 pdaru

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

Jun 29 '24 01:06 azure-pipelines[bot]

/pr RequestMerge

Jul 01 '24 02:07 FumingZhang

Still needs BreakingChange-JavaScript-Sdk-Suppression-Approved

Jul 01 '24 19:07 TimLovellSmith

Want to do another round of ARM review as we added a change in #29653 at the last minute

Jul 02 '24 02:07 FumingZhang

@FumingZhang Cool. Just one question about that: Is it a good idea having none by default? Wouldn't being "secure by default" be a better idea?

Jul 02 '24 13:07 TimLovellSmith

@FumingZhang Cool. Just one question about that: Is it a good idea having none by default? Wouldn't being "secure by default" be a better idea?

That's a good question. For now, we don't want to change the existing behavior of the API which has always defaulted to opt-in for adding a network policy engine.

All three of the network policy engines AKS supports today have tradeoffs, so it's somewhat difficult to recommend a good default that will work for every use case.

Jul 02 '24 18:07 wedaly

Piggybacking on what @wedaly said just to expand on this:

For now, we don't want to change the existing behavior of the API which has always defaulted to opt-in for adding a network policy engine.

The default has always been none, it's just that we displayed that default by just omitting it entirely in the API (empty/omitted meant none). Obviously there are problems with that which is part of the reason why we're trying to be more explicit here, but the default has always been (behaviorally) none.

Jul 02 '24 18:07 matthchr

/pr RequestMerge

Jul 04 '24 02:07 FumingZhang

Review request for Microsoft.ContainerService/aks to add version stable/2024-05-01

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Next Steps to Merge

Swagger Validation Report

Swagger Generation Artifacts

Generated ApiView