|
| 1 | +## ARM API Information (Control Plane) |
| 2 | + |
| 3 | +<i>MSFT employees can try out our new experience at <b>[OpenAPI Hub](https://aka.ms/openapiportal) </b> - one location for using our validation tools and finding your workflow. |
| 4 | +</i> |
| 5 | + |
| 6 | +### Changelog |
| 7 | +Add a changelog entry for this PR by answering the following questions: |
| 8 | + 1. What's the purpose of the update? |
| 9 | + - [ ] new service onboarding |
| 10 | + - [ ] new API version |
| 11 | + - [ ] update existing version for new feature |
| 12 | + - [ ] update existing version to fix swagger quality issue in s360 |
| 13 | + - [ ] Other, please clarify |
| 14 | + 2. 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. |
| 15 | + 3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. |
| 16 | + 4. 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. |
| 17 | + |
| 18 | +### Contribution checklist (MS Employees Only): |
| 19 | +- [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/AzBreakingChangesPolicy) of "no breaking changes" |
| 20 | +- [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow. |
| 21 | +- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and errors have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) |
| 22 | + |
| 23 | +If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). |
| 24 | + |
| 25 | +### ARM API Review Checklist |
| 26 | + |
| 27 | +> **Applicability**: :warning: |
| 28 | +> |
| 29 | +> If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review. |
| 30 | +> - Change to data plane APIs |
| 31 | +> - Adding new properties |
| 32 | +> - All removals |
| 33 | +
|
| 34 | +Otherwise your PR may be subject to ARM review requirements. Complete the following: |
| 35 | +- [ ] Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest. |
| 36 | + - Adding a new service |
| 37 | + - Adding new API(s) |
| 38 | + - Adding a new API version |
| 39 | + -[ ] 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](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version). |
| 40 | + |
| 41 | +- [ ] Ensure you've reviewed following [guidelines](https://aka.ms/rpguidelines) including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md). Estimated time (4 hours). This is required before you can request review from ARM API Review board. |
| 42 | + |
| 43 | +- [ ] 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 <ins>Azure Resource Manager service</ins>) from IcM and reach out to them. |
| 44 | + |
| 45 | +### Breaking Change Review Checklist |
| 46 | +If you have any breaking changes as defined in the [Breaking Change Policy](http://aka.ms/AzBreakingChangesPolicy/), request approval from the Breaking Change Review Board. |
| 47 | + |
| 48 | +**Action**: to initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Additional details on the process and office hours are on the [Breaking Change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes). |
| 49 | + |
| 50 | +NOTE: To update API(s) in public preview for over 1 year (refer to [Retirement of Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews)) |
| 51 | + |
| 52 | +Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview). |
| 53 | + |
0 commit comments