Update securityPostureReference in VMScaleSet API#28891
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| virtualMachineScaleSet.json | 2024-03-01(8434bfb) | 2024-03-01(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-03-01 | package-2024-03-01(8434bfb) | package-2024-03-01(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L6352 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L6376 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L297 |
LroPatch202 |
The async patch operation should return 202. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L350 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L374 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L413 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L439 |
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: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L506 |
ParametersInPost |
hibernate is a query parameter. Post operation must not contain any query parameter other than api-version. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L512 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L554 |
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: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L576 |
ParametersInPost |
forceDeletion is a query parameter. Post operation must not contain any query parameter other than api-version. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L582 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L624 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L646 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L677 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L822 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:secretUrl. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L854 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:sourceVault. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L854 |
LroPatch202 |
The async patch operation should return 202. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L866 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L896 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L935 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L964 |
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: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1235 |
ParametersInPost |
skipShutdown is a query parameter. Post operation must not contain any query parameter other than api-version. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1241 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1284 |
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: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1306 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1347 |
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: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1369 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1410 |
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: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1432 |
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: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1494 |
LroLocationHeader |
A 202 response should include an Location response header. Location: ComputeRP/stable/2024-03-01/virtualMachineScaleSet.json#L1535 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2024-03-01 |
️❌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.
️️✔️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]
Swagger Generation Artifacts
|
Generated ApiView
|
b9fc59a to
b71e51f
Compare
|
This PR has |
Can we skip BreakingChange review as this feature is not currently used by any customers? Original feature addition was placed in public repo however this property is consumed by Security Posture which is in pursuit of Private Preview. The |
b71e51f to
7161eff
Compare
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
|
Fix the required checks |
|
There was an extra ',' in the schema causing validation issues, this has been fixed & pushed for new checks. Seems all that's left from required checks is "Breaking Changes" which is justified through bugfix label. Let me know if any additional context is needed. |
|
@martinezdylan , the type change of |
Hi @raych1 , understood & exactly absolutely no customers have been onboarded to the service as we haven't even reached private preview as of yet. Zero customer impact. Much better CX whenever we do release. |
|
who can we ping about go sdk breaking change sign off? |
|
/pr RequestMerge |
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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 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
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. 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.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.