azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Users/visunda/german vpn
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, @vivek-microsoft Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 15 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| cosmos-db.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| cosmos-db.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| dataTransferService.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| managedCassandra.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| managedCassandra.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| mongoCluster.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| mongorbac.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| mongorbac.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| notebook.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| notebook.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| privateEndpointConnection.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| privateEndpointConnection.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| privateLinkResources.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| privateLinkResources.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| rbac.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| rbac.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| restorable.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| restorable.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
| services.json | 2023-03-15-preview(c9beb6f) | 2023-03-15(main) |
| services.json | 2023-03-15-preview(c9beb6f) | 2023-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 44 Errors, 72 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2023-03-15 | package-preview-2023-03-15(c9beb6f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 29 items are listed, please refer to log for more details.
The following errors/warnings exist before current PR submission:
Only 29 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L435 |
|
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L494 |
|
The response schema of operations API '/providers/Microsoft.DocumentDB/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L667 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L938 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L980 |
|
The resource ThroughputSettingsGetResults does not have a corresponding delete operation. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L1853 |
|
The nested resource 'ThroughputSettingsGetResults' does not have list operation, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L7741 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L9641 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L9665 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L9673 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L9701 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L9712 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L9997 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10134 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10502 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10561 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10613 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10621 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10732 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10783 |
|
The integer type does not have a format, please add it. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10797 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/cosmos-db.json#L10860 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L150 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L174 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L188 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L263 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L263 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L263 |
|
A 202 response should include an Location response header. Location: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L274 |
️❌Avocado: 6 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The example JSON file is not referenced from the swagger file. readme: specification/cosmos-db/resource-manager/readme.md json: preview/2023-03-15-preview/examples/CosmosDBManagedCassandraBackup.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/cosmos-db/resource-manager/readme.md json: preview/2023-03-15-preview/examples/CosmosDBManagedCassandraBackupsList.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/repair is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/fetchNodeStatus is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/backups is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2023-03-01-preview/managedCassandra.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/cassandraClusters/{}/backups/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2023-03-01-preview/managedCassandra.json |
| :warning: CIRCULAR_REFERENCE | The JSON file has a circular reference. readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2023-03-15-preview/privateEndpointConnection.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️❌PrettierCheck: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Code style issues found path: preview/2023-03-15-preview/examples/CosmosDBManagedCassandraClusterRepairRunList.json |
|
Code style issues found path: preview/2023-03-15-preview/examples/CosmosDBManagedCassandraClusterRepairShow.json |
|
Code style issues found path: preview/2023-03-15-preview/examples/CosmosDBManagedCassandraRepairCreate.json |
|
Code style issues found path: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json |
️❌SpellCheck: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (conenct), please fix the error or add words to ./custom-words.txt path: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L1505:87 |
|
Unknown word (deafukt), please fix the error or add words to ./custom-words.txt path: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L1505:138 |
|
Unknown word (conenct), please fix the error or add words to ./custom-words.txt path: Microsoft.DocumentDB/preview/2023-03-15-preview/managedCassandra.json#L1505:158 |
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️🔄ApiDocPreview inProgress [Detail]
️❌SDK Breaking Change Tracking failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-java warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-sdk-for-go failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-resource-manager-schemas warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-powershell failed [Detail]
Only 0 items are rendered, please refer to log for more details.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.DocumentDB | https://apiview.dev/Assemblies/Review/d1383e584add4ef396cdb87e5c59f881 |
| .Net | Azure.ResourceManager.CosmosDB | There is no API change compared with the previous version |
| JavaScript | @azure/arm-cosmosdb | https://apiview.dev/Assemblies/Review/7dbdc67b474e411bbbf70112a4fa79f0 |
Hi, @vivek-microsoft, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ The required check named
Swagger PrettierCheckhas failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it. - ❌ The required check named
Swagger SpellCheckhas failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.
@vivek-microsoft please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
- (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement
Contribution License Agreement
This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.
- Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
- Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
- Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
- Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
- Licenses.
- Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
- Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
- Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
- Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
- Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
- Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
- Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
- Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}