-
Notifications
You must be signed in to change notification settings - Fork 153
Fix workbooks deployment permissions documentation #1629
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
base: dev
Are you sure you want to change the base?
Conversation
Co-authored-by: KevDLR <86437159+KevDLR@users.noreply.github.com>
docs/workbooks.md
Outdated
To deploy FinOps workbooks using ARM templates, you need: | ||
- **Contributor** role or a role with `Microsoft.Resources/deployments/validate/action` permission | ||
- **Workbook Contributor** role to save workbooks after deployment | ||
- **Reader** role to view all workbook tabs | ||
|
||
> If you only have Reader access, you can download the workbook files from the [GitHub repository](https://github.com/microsoft/finops-toolkit/tree/main/src/workbooks) and import them directly into Azure Monitor Workbooks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To deploy FinOps workbooks using ARM templates, you need: | |
- **Contributor** role or a role with `Microsoft.Resources/deployments/validate/action` permission | |
- **Workbook Contributor** role to save workbooks after deployment | |
- **Reader** role to view all workbook tabs | |
> If you only have Reader access, you can download the workbook files from the [GitHub repository](https://github.com/microsoft/finops-toolkit/tree/main/src/workbooks) and import them directly into Azure Monitor Workbooks. | |
FinOps workbooks require the <strong>Workbook Contributor</strong> role to deploy and <strong>Reader</strong> on all subscriptions you want to monitor. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Simplified the permissions section with your suggested wording that's more concise and accurate. Commit de144d6
Co-authored-by: flanakin <399533+flanakin@users.noreply.github.com>
…ts/write permission Co-authored-by: KevDLR <86437159+KevDLR@users.noreply.github.com>
docs/workbooks.md
Outdated
FinOps workbooks require the <strong>Contributor</strong> role or a role with both <strong>Microsoft.Resources/deployments/validate/action</strong> and <strong>Microsoft.Resources/deployments/write</strong> permissions for ARM template deployments, <strong>Workbook Contributor</strong> role to save changes, and <strong>Reader</strong> on all subscriptions you want to monitor. | ||
|
||
> If you only have Reader access, you can download the workbook files from the [GitHub repository](https://github.com/microsoft/finops-toolkit/tree/main/src/workbooks) and import them directly into Azure Monitor Workbooks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FinOps workbooks require the <strong>Contributor</strong> role or a role with both <strong>Microsoft.Resources/deployments/validate/action</strong> and <strong>Microsoft.Resources/deployments/write</strong> permissions for ARM template deployments, <strong>Workbook Contributor</strong> role to save changes, and <strong>Reader</strong> on all subscriptions you want to monitor. | |
> If you only have Reader access, you can download the workbook files from the [GitHub repository](https://github.com/microsoft/finops-toolkit/tree/main/src/workbooks) and import them directly into Azure Monitor Workbooks. | |
FinOps workbooks require the <strong>Workbook Contributor</strong> role to deploy and <strong>Reader</strong> on any subscriptions you want to monitor. |
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
This PR updates the documentation related to the permissions required for deploying FinOps workbooks. The original documentation incorrectly stated that Reader access was sufficient to deploy workbooks, which is not true when using the ARM template deployment method.
Changes made:
Updated the permission requirements across all workbooks documentation:
Microsoft.Resources/deployments/validate/action
permission is required for ARM template deploymentsAdded alternative deployment instructions for users with only Reader access:
Ensured consistency across all related documentation files:
docs-mslearn/toolkit/workbooks/finops-workbooks-overview.md
docs-mslearn/toolkit/workbooks/customize-workbooks.md
docs/workbooks.md
src/templates/finops-workbooks/README.md
These changes address the issue where users with only Reader access are unable to deploy workbooks using the ARM template method, and provide clear alternatives for those users.
Fixes #1612.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.