azure-rest-api-specs
azure-rest-api-specs copied to clipboard
mgmt release planner test
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[ ] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[ ] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
-
[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @dw511214992 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Swagger Validation Report
️️✔️
BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
databoxedge.json | 2022-03-01(7931313) | 2022-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: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-03-01 | package-2022-03-01(7931313) | package-2022-03-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L188 |
ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L189 |
ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L236 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L292 |
ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L292 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L320 |
ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L340 |
PatchSkuProperty |
The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L354 |
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L394 |
ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L395 |
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L443 |
ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L444 |
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L496 |
ParametersOrder |
The parameters:deviceName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L497 |
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L545 |
ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L546 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L597 |
ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L597 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L637 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L644 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L644 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L661 |
ParametersOrder |
The parameters:deviceName,name,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L661 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L696 |
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L717 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L718 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L759 |
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L783 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'DeviceCapacityInfo' 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: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L789 |
ResourceNameRestriction |
The resource name parameter 'deviceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataBoxEdge/stable/2022-03-01/databoxedge.json#L829 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
~[Staging] CadlAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 27 Errors, 0 Warnings failed [Detail]
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
️️✔️
ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌
SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌
azure-sdk-for-go - sdk/resourcemanager/databoxedge/armdataboxedge - Approved - 2.0.0+ Struct `CloudErrorBody` has been removed + Struct `CloudError` has been removed
❌
azure-sdk-for-js - @azure/arm-databoxedge - Approved - 3.0.0+ Interface DevicesListByResourceGroupNextOptionalParams no longer has parameter expand + Interface DevicesListBySubscriptionNextOptionalParams no longer has parameter expand + Interface TriggersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter + Interface UsersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
️️✔️
azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️
Succeeded [Logs] Generate from de00d8d3df35cc2990cbbd7c223e66db27892285. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️
Azure.ResourceManager.DataBoxEdge [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️
azure-sdk-for-python-track2 warning [Detail]
⚠️
Warning [Logs] Generate from de00d8d3df35cc2990cbbd7c223e66db27892285. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.3.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.3.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️
track2_azure-mgmt-databoxedge [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group DiagnosticSettingsOperations info [Changelog] - Added operation group SupportPackagesOperations info [Changelog] - Model DataBoxEdgeSku has a new parameter capabilities
️️✔️
azure-sdk-for-js succeeded [Detail] [Expand]
️✔️
Succeeded [Logs] Generate from de00d8d3df35cc2990cbbd7c223e66db27892285. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️
@azure/arm-databoxedge [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group DeviceCapacityCheck info [Changelog] - Added operation group DeviceCapacityInfoOperations info [Changelog] - Added Interface ClusterCapacityViewData info [Changelog] - Added Interface ClusterGpuCapacity info [Changelog] - Added Interface ClusterMemoryCapacity info [Changelog] - Added Interface ClusterStorageViewData info [Changelog] - Added Interface DeviceCapacityCheckCheckResourceCreationFeasibilityOptionalParams info [Changelog] - Added Interface DeviceCapacityInfo info [Changelog] - Added Interface DeviceCapacityInfoGetDeviceCapacityInfoOptionalParams info [Changelog] - Added Interface DeviceCapacityRequestInfo info [Changelog] - Added Interface HostCapacity info [Changelog] - Added Interface NumaNodeData info [Changelog] - Added Interface VmMemory info [Changelog] - Added Interface VmPlacementRequestResult info [Changelog] - Added Type Alias ClusterWitnessType info [Changelog] - Added Type Alias DeviceCapacityInfoGetDeviceCapacityInfoResponse info [Changelog] - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessContainerName info [Changelog] - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessStorageAccountName info [Changelog] - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessStorageEndpoint info [Changelog] - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter clusterWitnessType info [Changelog] - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter fileShareWitnessLocation info [Changelog] - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter fileShareWitnessUsername info [Changelog] - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter systemData info [Changelog] - Interface Order has a new optional parameter kind info [Changelog] - Interface Order has a new optional parameter orderId info [Changelog] - Added Enum KnownClusterWitnessType info [Changelog] - Enum KnownSkuName has a new value EdgeMRTCP info [Changelog] - Enum KnownSkuName has a new value EP2128GPU1Mx1W info [Changelog] - Enum KnownSkuName has a new value EP2256GPU2Mx1 info [Changelog] - Enum KnownSkuName has a new value EP264Mx1W info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface DevicesListByResourceGroupNextOptionalParams no longer has parameter expand info [Changelog] - Interface DevicesListBySubscriptionNextOptionalParams no longer has parameter expand info [Changelog] - Interface TriggersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter info [Changelog] - Interface UsersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
️️✔️
azure-sdk-for-go succeeded [Detail] [Expand]
️✔️
Succeeded [Logs] Generate from de00d8d3df35cc2990cbbd7c223e66db27892285. SDK Automation 14.0.0command 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/databoxedge/armdataboxedge [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `CloudError` has been removed info [Changelog] - Struct `CloudErrorBody` has been removed info [Changelog] info [Changelog] Total 4 breaking change(s), 0 additive change(s).
️⚠️
azure-sdk-for-java warning [Detail]
⚠️
Warning [Logs] Generate from de00d8d3df35cc2990cbbd7c223e66db27892285. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️
azure-resourcemanager-databoxedge [View full logs] [Preview SDK Changes]
️⚠️
azure-resource-manager-schemas warning [Detail]
⚠️
Warning [Logs] Generate from de00d8d3df35cc2990cbbd7c223e66db27892285. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json warn No file changes detected after generation
️✔️
databoxedge [View full logs]
️️✔️
azure-powershell succeeded [Detail] [Expand]
️✔️
Succeeded [Logs] Generate from de00d8d3df35cc2990cbbd7c223e66db27892285. SDK Automation 14.0.0command 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.DataBoxEdge [View full logs] [Preview SDK Changes]
Generated ApiView
Language | Package Name | ApiView Link |
---|---|---|
Go | sdk/resourcemanager/databoxedge/armdataboxedge | https://apiview.dev/Assemblies/Review/deb45a2f11c94fa6b193a5bf282ea3aa |
Java | azure-resourcemanager-databoxedge | https://apiview.dev/Assemblies/Review/460ddf34cfae4f87b23728080203bf9e |
.Net | Azure.ResourceManager.DataBoxEdge | There is no API change compared with the previous version |
JavaScript | @azure/arm-databoxedge | https://apiview.dev/Assemblies/Review/f4eaa9611514403cb87421cf1fd3cc8e |
suppress model validation
Suppression for model validation
test
/azp run
Azure Pipelines successfully started running 1 pipeline(s).