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

[azure_billing] Add documentation for assigning roles in department and billing account scopes. #9105

Merged
merged 14 commits into from
Feb 22, 2024

Conversation

zmoog
Copy link
Contributor

@zmoog zmoog commented Feb 9, 2024

Proposed commit message

Add step-by-step instructions about which role to assign to the app registration to use the department or the billing account scopes.

When users want to collect billing metrics using the billing account scope, they must assign the "Department Reader" or the "Billing account reader" role in the IAM section at Cost Management + Billing. Before this change, we were only covering the subscription scope.

The department and billing account scopes allows users to access to data from multiple subscriptions.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

When users want to collect billing metrics using the billing account
scope, they must assign the "Billing account reader" role in the IAM
section at Cost Management + Billing.
@zmoog zmoog added the docs label Feb 9, 2024
@zmoog zmoog self-assigned this Feb 9, 2024
@zmoog zmoog added the enhancement New feature or request label Feb 9, 2024
@muthu-mps
Copy link
Contributor

@zmoog - As the requirement section already has a mention about the BillingReader role which can be assigned to subscription, department, or billing account. Can we update or remove the role definition here?

The App Registration requires the Billing Reader role to access the billing information for the subscription, department, or billing account.

@muthu-mps
Copy link
Contributor

  • Correct me if I am wrong, If the EA account holder is trying to access the billing metrics using the Department Id scope. Do they need to have the DepartmentReader role?
  • We may need to update the document by adding account level scopes (EA, MCA) with roles permissions.

@zmoog
Copy link
Contributor Author

zmoog commented Feb 9, 2024

Can we update or remove the role definition here?

Thanks, I missed that.

Correct me if I am wrong, If the EA account holder is trying to access the billing metrics using the Department Id scope. Do they need to have the DepartmentReader role?

You're right, we are not providing guidance for the department scope.

Unfortunately, I don't have the required access level to test this on our EA account. We need to find someone to help us here to cover the department scope.

@zmoog
Copy link
Contributor Author

zmoog commented Feb 14, 2024

@muthu-mps, I still can't personally test this scenario, but I used the link you shared to update the docs.

@zmoog zmoog marked this pull request as ready for review February 14, 2024 15:57
@zmoog zmoog requested a review from a team as a code owner February 14, 2024 15:57
@zmoog zmoog requested a review from alaudazzi February 14, 2024 15:57
@zmoog zmoog changed the title [azure_billing] Add missing role assignment information for the billing account scope [azure_billing] Add missing role assignment docs for department and billing account scopes Feb 14, 2024
@zmoog zmoog changed the title [azure_billing] Add missing role assignment docs for department and billing account scopes [azure_billing] Add documentation for assigning roles in department and billing account scopes. Feb 14, 2024
Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few editing suggestions, otherwise LGTM.

packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved
packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved
packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved
packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved

To collect billing metrics using from a department (instead of from a subscription):

1. In the [Azure Portal](https://portal.azure.com/), search for and select **Cost Management + Billing**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. In the [Azure Portal](https://portal.azure.com/), search for and select **Cost Management + Billing**.
1. In the [Azure Portal](https://portal.azure.com/), search for and select **Cost Management** and **Billing**.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alaudazzi, I know it looks weird, but "Cost Management + Billing" is the actual name of the service:

CleanShot 2024-02-15 at 19 40 01@2x

Should we use "Cost Management and Billing" instead?

packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved
packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved

To collect billing metrics using from a billing account (instead of from a subscription):

1. In the [Azure Portal](https://portal.azure.com/), search for and select **Cost Management + Billing**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. In the [Azure Portal](https://portal.azure.com/), search for and select **Cost Management + Billing**.
1. In the [Azure Portal](https://portal.azure.com/), search for and select **Cost Management** and **Billing**.

packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved
packages/azure_billing/_dev/build/docs/README.md Outdated Show resolved Hide resolved
zmoog and others added 11 commits February 15, 2024 19:37
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
@elasticmachine
Copy link

💚 Build Succeeded

History

cc @zmoog

Copy link

Quality Gate passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No Coverage information No data about Coverage
No Duplication information No data about Duplication

See analysis details on SonarQube

@zmoog zmoog merged commit e3cb98b into elastic:main Feb 22, 2024
5 checks passed
@zmoog zmoog deleted the zmoog/azure-billing-account-docs branch February 22, 2024 15:27
@elasticmachine
Copy link

Package azure_billing - 1.4.1 containing this change is available at https://epr.elastic.co/search?package=azure_billing

gizas pushed a commit that referenced this pull request Mar 13, 2024
…nd billing account scopes. (#9105)

* Add role assignment info for billing account scope

When users want to collect billing metrics using the billing account
scope, they must assign the "Billing account reader" role in the IAM
section at Cost Management + Billing.


---------

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants