Skip to content
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

Document the need for and side effects of using Microsoft.Security/policies resource provider #606

Closed
brooke-hamilton opened this issue Jan 13, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@brooke-hamilton
Copy link
Contributor

brooke-hamilton commented Jan 13, 2022

Benefit/Result/Outcome

So that a person who sees the warnings emitted by the code has confidence in the quality of MLZ.

Description

The Microsoft.Security/policies@2015-06-01-sdpreview resource provider is used in our Bicep code to deploy the policy assignment associated with the advanced version of Azure Security Center/Defender. The provider is not documented and generates a Bicep warning, which causes users to wonder why the provider is being used.

Acceptance Criteria

  • Suppress the warning emitted by the code using the #disable-next-line <rule or warning> Bicep syntax.
  • Add a comment to the Microsoft.Security/policies@2015-06-01-sdpreview module explaining why the resource provider is being used.
@brooke-hamilton brooke-hamilton added documentation Improvements or additions to documentation needs triage labels Jan 13, 2022
@glennmusa
Copy link
Contributor

as of Bicep 0.4.1124 the #disable-next-line <rule or warning> syntax allows for supressing individual warnings:

DisableNextLineDiagnostics

https://github.com/Azure/bicep/releases/tag/v0.4.1124

@brooke-hamilton
Copy link
Contributor Author

as of Bicep 0.4.1124 the #disable-next-line <rule or warning> syntax allows for supressing individual warnings:

https://github.com/Azure/bicep/releases/tag/v0.4.1124

Thanks! I updated the acceptance criteria to specify the #disable-next-line <rule or warning> syntax.

@brooke-hamilton
Copy link
Contributor Author

Closing: #485 makes this backlog item OBE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants