Add isManagedIdentityInUse property to DevOps Audit Api #18791
Add isManagedIdentityInUse property to DevOps Audit Api #18791raych1 merged 1 commit intodev-sql-Microsoft.Sql-2022-02-01-previewfrom
Conversation
|
Hi, @msdogra Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2022-02-01-preview/ServerDevOpsAudit.json compared with base:preview/2021-11-01-preview/ServerDevOpsAudit.json
️️✔️SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-02", "details":"Error: Plugin checker reported failure." |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
|
Hi, @msdogra your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
| "description": "Specifies whether DevOps audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", | ||
| "type": "boolean" | ||
| }, | ||
| "isManagedIdentityInUse": { |
There was a problem hiding this comment.
Recommend string enum instead of boolean. Enums are better properties for many reasons. In this case, you could do something more like blobStorageAccess: { Default, ManagedIdentity } (or better yet, name the default case). This approach also allows adding new enum values without creating a new API version. #Resolved
There was a problem hiding this comment.
This API mimics the existing Auditing API, changing this to an enum would require changes in the auditing API and would require a lot of changes in other parts of the code.
There was a problem hiding this comment.
the suggestion is very good.
I guess this parameter is following existing other auditing APIs. the customer might have onboarded the existing bool style auditing APIs for their scripts or workflow.
There was a problem hiding this comment.
Not blocking ARM signoff on this, just a recommendation.
|
@msdogra , do you want to make the change from |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
What's the purpose of the update?
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.
May 2022
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. -May 2022
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.