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

Extract New-ResourceGroup private command for reuse #656

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

flanakin
Copy link
Collaborator

@flanakin flanakin commented Mar 27, 2024

πŸ› οΈ Description

Extract the new RG creation from Deploy-FinOpsHub to reuse in other commands.

πŸ“‹ Checklist

πŸ”¬ How did you test this change?

  • 🀏 Lint tests
  • 🀞 PS -WhatIf / az validate
  • πŸ‘ Manually deployed + verified
  • πŸ’ͺ Unit tests
  • πŸ™Œ Integration tests

πŸ™‹β€β™€οΈ Do any of the following that apply?

  • 🚨 This is a breaking change.
  • 🀏 The change is less than 20 lines of code.

πŸ“‘ Did you update docs/changelog.md?

  • βœ… Updated changelog (required for dev PRs)
  • ➑️ Will add log in a future PR (feature branch PRs only)
  • ❎ Log not needed (small/internal change)

πŸ“– Did you update documentation?

  • βœ… Public docs in docs (required for dev)
  • βœ… Internal dev docs in src (required for dev)
  • ➑️ Will add docs in a future PR (feature branch PRs only)
  • ❎ Docs not needed (small/internal change)

Comment on lines +8 to +14
.EXAMPLE
New-ResourceGroup -WhatIf

Shows what would happen if the command runs without actually running it.

.DESCRIPTION
The New-ResourceGroup command performs any initialization tasks required for a resource group contributor to be able to deploy a FinOps hub instance in Azure, like registering resource providers. To view the full list of tasks performed, run the command with the -WhatIf option.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
.EXAMPLE
New-ResourceGroup -WhatIf
Shows what would happen if the command runs without actually running it.
.DESCRIPTION
The New-ResourceGroup command performs any initialization tasks required for a resource group contributor to be able to deploy a FinOps hub instance in Azure, like registering resource providers. To view the full list of tasks performed, run the command with the -WhatIf option.
.DESCRIPTION
The New-ResourceGroup command performs any initialization tasks required for a resource group contributor to be able to deploy a FinOps hub instance in Azure, like registering resource providers. To view the full list of tasks performed, run the command with the -WhatIf option.
.EXAMPLE
New-ResourceGroup -WhatIf
Shows what would happen if the command runs without actually running it.

.SYNOPSIS
Creates a new resource group.

.EXAMPLE
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Add parameters to the docs

<#
.SYNOPSIS
Creates a new resource group.

Copy link
Member

@helderpinto helderpinto Jul 28, 2024

Choose a reason for hiding this comment

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

Adding parameters...

Suggested change
.PARAMETER Name
Specifies a name for the resource group. The resource group name must be unique in the subscription. If a resource group that has that name already exists, the command prompts you for confirmation before replacing the existing resource group.
.PARAMETER Location
Specifies the location of the resource group.
.PARAMETER Tags
Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Review πŸ‘€ PR that is ready to be reviewed Tool: PowerShell PowerShell scripts and automation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants