New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Private Only Feature #28834
base: release-network-Microsoft.Network-2024-01-01
Are you sure you want to change the base?
Add Private Only Feature #28834
Conversation
Thank you for your contribution zhaochongliu! We will review the pull request and get back to you soon. |
Next Steps to MergeNext steps that must be taken to merge this PR:
|
PR validation pipeline started successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
PR validation pipeline started successfully. This comment will be populated with the 'Swagger Validation Report' |
PR validation pipeline started successfully. This comment will be populated with the 'Swagger Generation Artifacts' report |
Swagger Validation Report
|
Compared specs (v0.10.8) | new version | base version |
---|---|---|
bastionHost.json | 2024-01-01(25f0004) | 2023-11-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1025 - RequiredStatusChange |
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.Network/stable/2024-01-01/bastionHost.json#L792:7 Old: Microsoft.Network/stable/2023-11-01/bastionHost.json#L676:7 |
️❌
LintDiff: 15 Errors, 3 Warnings failed [Detail]
Compared specs (v2.2.0) | new version | base version |
---|---|---|
package-2024-01 | package-2024-01(25f0004) | package-2024-01(release-network-Microsoft.Network-2024-01-01) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationGateway.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/dscpConfiguration.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/loadBalancer.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkInterface.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkProfile.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/networkSecurityGroup.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateEndpoint.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/privateLinkService.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/publicIpAddress.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/routeTable.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/serviceEndpointPolicy.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetwork.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualNetworkTap.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/virtualWan.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/webapplicationfirewall.json'. Errors encountered: TypeError: Cannot read properties of null (reading 'additionalProperties') Location: azure-rest-api-specs/blob/25f0004a7e4f763c40363f2cbea7f83180462a97/#L1 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L652 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L712 |
||
Schema should have a description or title. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1184 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L38 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L59 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L235 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L369 |
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: Microsoft.Network/stable/2024-01-01/bastionHost.json#L394 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L422 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L572 |
MissingTypeObject |
The schema 'BastionHostIPConfigurationPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L791 |
MissingTypeObject |
The schema 'BastionHostIPConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L816 |
MissingTypeObject |
The schema 'BastionHostPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L845 |
MissingTypeObject |
The schema 'networkAcls' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L862 |
MissingTypeObject |
The schema 'BastionHost' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L929 |
MissingTypeObject |
The schema 'BastionHostListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L960 |
MissingTypeObject |
The schema 'BastionShareableLink' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L976 |
MissingTypeObject |
The schema 'BastionShareableLinkListRequest' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1003 |
MissingTypeObject |
The schema 'BastionShareableLinkListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1028 |
MissingTypeObject |
The schema 'BastionActiveSession' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1044 |
MissingTypeObject |
The schema 'BastionActiveSessionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1112 |
MissingTypeObject |
The schema 'BastionSessionState' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1128 |
MissingTypeObject |
The schema 'BastionSessionDeleteResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1148 |
MissingTypeObject |
The schema 'SessionIds' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L1172 |
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L44 |
|
The response of operation:'BastionHosts_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L88 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L94 |
|
The response of operation:'BastionHosts_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L134 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L140 |
|
The response of operation:'BastionHosts_UpdateTags' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L199 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L205 |
|
The patch operation body parameter schema should contain property 'sku'. Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L215 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2024-01-01/bastionHost.json#L263 |
️❌
Avocado: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
UNREFERENCED_JSON_FILE |
The example JSON file is not referenced from the swagger file. readme: specification/network/resource-manager/readme.md json: stable/2024-01-01/examples/BastionHostGetWithPrivateOnly.json |
UNREFERENCED_JSON_FILE |
The example JSON file is not referenced from the swagger file. readme: specification/network/resource-manager/readme.md json: stable/2024-01-01/examples/BastionHostPutWithPrivateOnly.json |
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
PR validation pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
Swagger Generation Artifacts
|
Generated ApiView
|
@microsoft-github-policy-service agree company="Microsoft" |
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.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
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:
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
Purpose of this PR
andDue diligence checklist
.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.and https://aka.ms/ci-fix.
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.