-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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 mongo v5 and v6 to the swagger #28473
Merged
pjohari-ms
merged 1 commit into
Azure:release-cosmos-db-Microsoft.DocumentDB-2024-05-15
from
AndrewKhoma:users/andrewkhoma/ga-mongo-v5-v6
Mar 27, 2024
Merged
Add mongo v5 and v6 to the swagger #28473
pjohari-ms
merged 1 commit into
Azure:release-cosmos-db-Microsoft.DocumentDB-2024-05-15
from
AndrewKhoma:users/andrewkhoma/ga-mongo-v5-v6
Mar 27, 2024
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
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.7) | new version | base version |
---|---|---|
cosmos-db.json | 2024-05-15(1a27732) | 2023-11-15(main) |
cosmos-db.json | 2024-05-15(1a27732) | 2024-02-15-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.DocumentDB/databaseAccounts/{accountName}/graphs' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L1499:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/graphs/{graphName}' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L1535:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/partitionMerge' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L2388:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/partitionMerge' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L2456:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L2744:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/redistributeThroughput' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L2812:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L2880:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/redistributeThroughput' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L2951:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4010:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/redistributeThroughput' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4078:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/retrieveThroughputDistribution' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4146:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/redistributeThroughput' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4217:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/partitionMerge' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4477:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/partitionMerge' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L4545:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L6848:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L6887:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7037:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToAutoscale' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7136:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/views/{viewName}/throughputSettings/default/migrateToManualThroughput' removed or restructured? Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7195:5 |
|
The new version is missing a definition that was found in the old version. Was 'GraphResourceCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'GraphResourceCreateUpdateProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'GraphResource' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'CassandraViewCreateUpdateParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'CassandraViewCreateUpdateProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'RedistributeThroughputParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'RedistributeThroughputProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'RedistributeThroughputPropertiesResource' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'RetrieveThroughputParameters' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'RetrieveThroughputProperties' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
|
The new version is missing a definition that was found in the old version. Was 'RetrieveThroughputPropertiesResource' removed or renamed? New: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L5823:3 Old: Microsoft.DocumentDB/preview/2024-02-15-preview/cosmos-db.json#L7255:3 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.0) | new version | base version |
---|---|---|
package-2024-05 | package-2024-05(1a27732) | package-2024-05(release-cosmos-db-Microsoft.DocumentDB-2024-05-15) |
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: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L69 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:defaultConsistencyLevel. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L95 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L95 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L110 |
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.DocumentDB/stable/2024-05-15/cosmos-db.json#L157 |
PostResponseCodes |
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: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L201 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L317 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L350 |
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.DocumentDB/stable/2024-05-15/cosmos-db.json#L386 |
DefaultErrorResponseSchema |
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/stable/2024-05-15/cosmos-db.json#L435 |
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.DocumentDB/stable/2024-05-15/cosmos-db.json#L445 |
DefaultErrorResponseSchema |
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/stable/2024-05-15/cosmos-db.json#L494 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L504 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L535 |
PostResponseCodes |
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: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L568 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L641 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.DocumentDB/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L667 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L668 |
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. There is one exception for extension resources with fully qualified path and the author can go ahead and suppress the error(look at https://github.com/Azure/azure-openapi-validator/blob/main/docs/path-for-nested-resource.md#pathfornestedresource for more details) Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L938 |
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. There is one exception for extension resources with fully qualified path and the author can go ahead and suppress the error(look at https://github.com/Azure/azure-openapi-validator/blob/main/docs/path-for-nested-resource.md#pathfornestedresource for more details) Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L980 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L1570 |
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.DocumentDB/stable/2024-05-15/cosmos-db.json#L1627 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L1673 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L1674 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L1708 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L1955 |
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.DocumentDB/stable/2024-05-15/cosmos-db.json#L2015 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L2064 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L2065 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DocumentDB/stable/2024-05-15/cosmos-db.json#L2102 |
️️✔️
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.
️️✔️
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 Mar 27, 2024
AzureRestAPISpecReview
added
ARMReview
resource-manager
WaitForARMFeedback
<valid label in PR review process> add this label when ARM review is required
labels
Mar 27, 2024
ms-henglu
added
the
ARMSignedOff
<valid label in PR review process>add this label when ARM approve updates after review
label
Mar 27, 2024
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
<valid label in PR review process> add this label when ARM review is required
label
Mar 27, 2024
/pr RequestMerge |
pjohari-ms
approved these changes
Mar 27, 2024
pjohari-ms
merged commit Mar 27, 2024
0f52076
into
Azure:release-cosmos-db-Microsoft.DocumentDB-2024-05-15
27 of 29 checks passed
mentat9
pushed a commit
that referenced
this pull request
May 16, 2024
* Adds base for updating Microsoft.DocumentDB from version stable/2023-11-15 to version 2024-05-15 * Updates readme * Updates API version in new specs and examples * Add mongo v5 and v6 to the swagger (#28473) Co-authored-by: Andrew Khoma <[email protected]> * [CosmosDB-MICassandra] Added VPN feature properties to stable (#28540) * Added VPN feature properties * Fixed SpellCheck violation and added arm-id format to privateLinkResourceId * Added arm-id-details to privateLinkResourceId --------- Co-authored-by: drewkaufmann <[email protected]> * SqlDedicatedGateway DistributedQuery stable changes (#28747) * Distributed Query changes * Nits * Fixed model validation * More fixes * Nits - review comments (#28957) * Nits - Services.json (#29020) * add sdk-suppressions.yaml (#29077) --------- Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Guanzhou Song <[email protected]> Co-authored-by: drewkaufmann <[email protected]> Co-authored-by: Peng Jiahui <[email protected]>
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
) * Adds base for updating Microsoft.DocumentDB from version stable/2023-11-15 to version 2024-05-15 * Updates readme * Updates API version in new specs and examples * Add mongo v5 and v6 to the swagger (Azure#28473) Co-authored-by: Andrew Khoma <[email protected]> * [CosmosDB-MICassandra] Added VPN feature properties to stable (Azure#28540) * Added VPN feature properties * Fixed SpellCheck violation and added arm-id format to privateLinkResourceId * Added arm-id-details to privateLinkResourceId --------- Co-authored-by: drewkaufmann <[email protected]> * SqlDedicatedGateway DistributedQuery stable changes (Azure#28747) * Distributed Query changes * Nits * Fixed model validation * More fixes * Nits - review comments (Azure#28957) * Nits - Services.json (Azure#29020) * add sdk-suppressions.yaml (Azure#29077) --------- Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Andrew Khoma <[email protected]> Co-authored-by: Guanzhou Song <[email protected]> Co-authored-by: drewkaufmann <[email protected]> Co-authored-by: Peng Jiahui <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
ARMReview
ARMSignedOff
<valid label in PR review process>add this label when ARM approve updates after review
resource-manager
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.
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.