Added existing API versions from Private repo for Microsoft.Datadog
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.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix OpenAPI spec quality issues in S360.
- [ ] Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
- [ ] Other, please clarify:
- edit this with your clarification
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:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] I have reviewed following Resource Provider guidelines, including
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
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - If you don't have permissions to remove or add labels to the PR, request
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories - To understand what you must do next to merge this PR, see the
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. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ This is the public specs repo
mainbranch which is not intended for iterative development.
You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
If this is what you intend, addPublishToCustomerslabel to your PR.
Otherwise, retarget this PR onto a feature branch, i.e. with prefixrelease-(see aka.ms/azsdk/api-versions#release--branches). - ❌ This PR is in purview of the ARM review (label:
ARMReview). This PR must getARMSignedOfflabel from an ARM reviewer.
This PR is not ready for ARM review (label:NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of thisNext Steps to Mergecomment for details.
Once the blocking problems are addressed, add to the PR a comment with contents/azp run. Automation will re-evaluate this PR and if everything looks good, it will addWaitForARMFeedbacklabel which will put this PR on the ARM review queue.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review - ❌ This PR is
NotReadyForARMReviewbecause it has theBreakingChangeReviewRequiredlabel. - ❌ This PR has at least one breaking change (label:
BreakingChangeReviewRequired).
To unblock this PR, follow the process at aka.ms/brch. - ❌ The required check named
Swagger ModelValidationhas failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/datadog/armdatadog | https://apiview.dev/Assemblies/Review/1128e97fe7304c7195666ad46d8b21cc?revisionId=f8d7298ebcb94aa3a7cfca53b60b460c |
| Swagger | Microsoft.Datadog | https://apiview.dev/Assemblies/Review/541753aa2caf41c9b2c3501ca490243f?revisionId=9fdf9974410e47eb861cb7473b2584c6 |
@BhanujaAggarwal - Please select and fill out the appropriate PR template above.
@BhanujaAggarwal Please provide approved swagger link for the one in Private repo, I am hoping that the questions raised were answered in there.
Also please fix the required check failure of LintDiff
@BhanujaAggarwal - Please select and fill out the appropriate PR template above.
@mentat9 I have added the appropriate PR template now. Let me know if any additional details are required.
@BhanujaAggarwal Please provide approved swagger link for the one in Private repo, I am hoping that the questions raised were answered in there.
Also please fix the required check failure of LintDiff
@ramoka178
Please find below respective links from the Private repo for the API versions added as part of this PR. 2023-07-07 : https://github.com/Azure/azure-rest-api-specs-pr/commit/d9492d0b17ea56da87785fc85f701856cd8267d2 2023-10-20 : https://github.com/Azure/azure-rest-api-specs-pr/commit/7c8061964ae5f83bdb3a27b6351024963dbebb57
Lint Errors ;-
- ResourceNameRestriction : This lint error needs to be fixed throughout the code. This will be a breaking change.
- XmsPageableForListCalls : I will fix this error as part of the next change which I'll be committing.
- GetCollectionResponseSchema] : I will fix this error as part of the next change which I'll be committing.
- ProvisioningStateMustBeReadOnly : Many of these instances are false positive. We are picking models from #definitions, where the readonly flag has been specified.
Adding a note to reviewers. We’re currently under a tight deadline and some of the breaking changes are blocking the delivery of a critical feature (for which we need to remove an existing API version from the private repo immediately after these changes are merged and commit new API versions afterwards). It would be very helpful if we could address some of the changes separately, allowing us to move forward on the essential aspects of this PR. We appreciate your understanding and would like to prioritize the changes that can be implemented as a follow-up.
Thank you!
@ramoka178 @mentat9 can you help us with the review here? We have another dependency and need this PR to be merged. Thank you!
@ramoka178 can you please help with the review?
@ramoka178 can you please help with the review?
Updated the labels for this label to be in queue.
/azp run
Azure Pipelines successfully started running 2 pipeline(s).
The author of this PR is OOF this week. I have created a new PR with all the suggested changes. Will close this PR. https://github.com/Azure/azure-rest-api-specs/pull/31548?expand=1&template=control_plane_template.md
Please help with approval of the above PR, thank you! @razvanbadea-msft
@razvanbadea-msft, can you please help with the review on the new PR. We have a critical feature to deliver dependent on this.
Hi, @BhanujaAggarwal. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @BhanujaAggarwal. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.