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

[Hubs] Document what a scope ID is #487

Closed
flanakin opened this issue Dec 13, 2023 · 1 comment · Fixed by #509
Closed

[Hubs] Document what a scope ID is #487

flanakin opened this issue Dec 13, 2023 · 1 comment · Fixed by #509
Labels
Skill: Documentation Documentation updates Tool: FinOps hubs Data pipeline solution
Milestone

Comments

@flanakin
Copy link
Collaborator

⚠️ Problem

Hubs deployment steps reference a scope resource ID, but don't adequately explain what it is.

🛠️ Solution

Document the fact that a scope resource ID is the ARM resource ID for the scope (e.g., "/subscriptions/###" or "/providers/Microsoft.Billing/billingAccounts/###")

🙋‍♀️ Ask for the community

We could use your help:

  1. Please vote this issue up (👍) to prioritize it.
  2. Leave comments to help us solidify the vision.
@flanakin flanakin added the Needs: Triage 🔍 Untriaged issue needs to be reviewed label Dec 13, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot added the Tool: FinOps hubs Data pipeline solution label Dec 13, 2023
@flanakin flanakin added Skill: Documentation Documentation updates and removed Needs: Triage 🔍 Untriaged issue needs to be reviewed labels Dec 13, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs: Triage 🔍 Untriaged issue needs to be reviewed label Dec 13, 2023
@flanakin flanakin added this to the 0.1.2 milestone Dec 13, 2023
@flanakin flanakin removed the Needs: Triage 🔍 Untriaged issue needs to be reviewed label Dec 13, 2023
@flanakin flanakin removed their assignment Dec 13, 2023
flanakin added a commit that referenced this issue Dec 19, 2023
@psilantropy
Copy link

psilantropy commented Jan 24, 2024

Hi :)

I feel like this could be clarified further and is open to readers interpretation and errors.

Directory = (Use the resource ID of the scope1 you’re exporting without the first “/”)

  1. A “scope” is an Azure construct that contains resources or enables purchasing services, like a resource group, subscription, management group, or billing account. The resource ID for a scope will be the Azure Resource Manager URI that identifies the scope (e.g., “/subscriptions/###” for a subscription or “/providers/Microsoft.Billing/billingAccounts/###” for a billing account).

The example shows full paths, but references ### as the required input, or the entire "quote". However the Directory input advises to not use the first "/" which is within the example quotes.

I'm not sure is anything to gain (for this deployment) by reading the linked document on scopes.

E.g.

Scopes

Subscription - Use Subscription ID
Management Group - Use ID
Billing Account - Use Billing account ID
(i'm assuming i'm correct here!...)

Plus a screenshot of an example export.

Something else I thought would be useful is to include screenshots of an example storage account and the container paths after a successful export to msexports, and then a successful ingestion into ingestion. Showing this end-state would help users verify exports are working correctly.

Overwrite = TRUE is also enabled by default in the new export process, but not mentioned in the doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skill: Documentation Documentation updates Tool: FinOps hubs Data pipeline solution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants