Add API spec for AKS HostNetwork NSG Control #26385
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zarvd
requested review from
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| managedClusters.json | 2023-10-01(22452d6) | 2023-09-01(main) |
| managedClusters.json | 2023-10-01(22452d6) | 2023-09-02-preview(main) |
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 |
|---|---|
| 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/2023-09-02-preview/managedClusters.json#L1351:5 |
|
| 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/2023-09-02-preview/managedClusters.json#L1399:5 |
|
| 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/2023-09-02-preview/managedClusters.json#L2678:5 |
|
| 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/2023-09-02-preview/managedClusters.json#L2717:5 |
|
| 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/2023-09-02-preview/managedClusters.json#L2759:5 |
|
| 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/2023-09-02-preview/managedClusters.json#L3186:5 |
|
| 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/2023-09-02-preview/managedClusters.json#L3229:5 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterNodeResourceGroupProfile' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolWindowsProfile' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolSecurityProfile' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolGPUProfile' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolArtifactStreamingProfile' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolSSHAccess' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterIngressProfile' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterIngressProfileWebAppRouting' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileImageIntegrity' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileNodeRestriction' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileCustomCATrustCertificates' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSnapshot' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSnapshotProperties' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterPropertiesForSnapshot' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkProfileForSnapshot' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPlugin' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPluginMode' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPolicy' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkMode' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkDataplane' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkMonitoring' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'LoadBalancerSku' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
|
| The new version is missing a definition that was found in the old version. Was 'CapacityReservationGroupID' removed or renamed? New: aks/stable/2023-10-01/managedClusters.json#L2951:3 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3449:3 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-10 | package-2023-10(22452d6) | package-2023-10(dev-containerservice-Microsoft.ContainerService-2023-10-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/stable/2023-10-01/managedClusters.json#L52 |
|
Operations API path must follow the schema provided in the common types. Location: aks/stable/2023-10-01/managedClusters.json#L53 |
|
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/stable/2023-10-01/managedClusters.json#L80 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/stable/2023-10-01/managedClusters.json#L137 |
|
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/stable/2023-10-01/managedClusters.json#L278 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-10-01/managedClusters.json#L336 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-10-01/managedClusters.json#L381 |
|
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-10-01/managedClusters.json#L381 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/stable/2023-10-01/managedClusters.json#L429 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L553 |
|
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/2023-10-01/managedClusters.json#L636 |
|
The patch operation body parameter schema should contain property 'identity'. Location: aks/stable/2023-10-01/managedClusters.json#L655 |
|
The async patch operation should return 202. Location: aks/stable/2023-10-01/managedClusters.json#L665 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L675 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L722 |
|
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/stable/2023-10-01/managedClusters.json#L782 |
|
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/2023-10-01/managedClusters.json#L952 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L996 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L1148 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L1246 |
|
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/2023-10-01/managedClusters.json#L1308 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/stable/2023-10-01/managedClusters.json#L1328 |
|
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/2023-10-01/managedClusters.json#L1347 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L1393 |
|
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/2023-10-01/managedClusters.json#L1409 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L1456 |
|
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/2023-10-01/managedClusters.json#L1472 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L1509 |
|
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/2023-10-01/managedClusters.json#L1525 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/stable/2023-10-01/managedClusters.json#L1566 |
️️✔️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]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Oct 26, 2023
FumingZhang
approved these changes
Oct 26, 2023
FumingZhang
merged commit 5cb62f5
into
Azure:dev-containerservice-Microsoft.ContainerService-2023-10-01
24 of 28 checks passed
zizw123
pushed a commit
that referenced
this pull request
Nov 7, 2023
…add version stable/2023-10-01 (#26483) * Adds base for updating Microsoft.ContainerService/aks from version stable/2023-09-01 to version 2023-10-01 * Updates readme * Updates API version in new specs and examples * Add rest api specs for node public IP IPtags and IP-based Load Balancers (#26389) * feat: add rest api spec for node public IP IPTags * feat: add rest api spec for ip-based load balancer * Add API spec for AKS HostNetwork NSG Control (#26385) * update readme (#26388) * Update custom words for ContainerService/aks 2023-10-01 (#26481) * add CapacityReservationGroup into custom-words.txt (#26461) Co-authored-by: tong chen <tonche@microsoft.com> * add lower case capacityreservationgroup (#26475) Co-authored-by: tong chen <tonche@microsoft.com> --------- Co-authored-by: Tong Chen <99183466+tonychen15@users.noreply.github.com> Co-authored-by: tong chen <tonche@microsoft.com> * restored to dev branch base (#26451) Co-authored-by: tong chen <tonche@microsoft.com> * resolve conflict (#26585) --------- Co-authored-by: Qi Ni <pomelonicky@gmail.com> Co-authored-by: Jialun Cai <jialun.cai@pm.me> Co-authored-by: Tong Chen <99183466+tonychen15@users.noreply.github.com> Co-authored-by: tong chen <tonche@microsoft.com>
zman-ms
pushed a commit
that referenced
this pull request
Jan 10, 2024
…add version stable/2023-10-01 (#26483) * Adds base for updating Microsoft.ContainerService/aks from version stable/2023-09-01 to version 2023-10-01 * Updates readme * Updates API version in new specs and examples * Add rest api specs for node public IP IPtags and IP-based Load Balancers (#26389) * feat: add rest api spec for node public IP IPTags * feat: add rest api spec for ip-based load balancer * Add API spec for AKS HostNetwork NSG Control (#26385) * update readme (#26388) * Update custom words for ContainerService/aks 2023-10-01 (#26481) * add CapacityReservationGroup into custom-words.txt (#26461) Co-authored-by: tong chen <tonche@microsoft.com> * add lower case capacityreservationgroup (#26475) Co-authored-by: tong chen <tonche@microsoft.com> --------- Co-authored-by: Tong Chen <99183466+tonychen15@users.noreply.github.com> Co-authored-by: tong chen <tonche@microsoft.com> * restored to dev branch base (#26451) Co-authored-by: tong chen <tonche@microsoft.com> * resolve conflict (#26585) --------- Co-authored-by: Qi Ni <pomelonicky@gmail.com> Co-authored-by: Jialun Cai <jialun.cai@pm.me> Co-authored-by: Tong Chen <99183466+tonychen15@users.noreply.github.com> Co-authored-by: tong chen <tonche@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
GA AKS NSG Control API. Preview API: #20949
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
refer: #20949
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 ApiViewcomment 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.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links