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

[AVM Module Issue]: Improve (fix) naming on Virtual Wan Hub Connections #3085

Closed
1 task done
noopman opened this issue Aug 22, 2024 · 4 comments · Fixed by #3110
Closed
1 task done

[AVM Module Issue]: Improve (fix) naming on Virtual Wan Hub Connections #3085

noopman opened this issue Aug 22, 2024 · 4 comments · Fixed by #3110
Assignees
Labels
Class: Pattern Module 📦 This is a pattern module Status: In PR 👉 This is when an issue is due to be fixed in an open PR Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue Type: Feature Request ➕ New feature or request

Comments

@noopman
Copy link

noopman commented Aug 22, 2024

Check for previous/existing GitHub issues

  • I have checked for previous/existing GitHub issues

Issue Type?

Feature Request

Module Name

avm/ptn/lz/sub-vending

(Optional) Module Version

No response

Description

The naming of Virtual Wan Hub Connections is based on a guid. It looks incredibly ugly in the list of connections. Real world example: vhc-48b529d4-e9c0-5a89-87d8-a413512e103f

I propose:

  • Make much better names for the connection using the vnet name as part of the connection name by default!
  • Consider allowing the connection name to be an optional parameter!

Here is the exact location in code where the virtualWanHubConnectionName is set.

var virtualWanHubConnectionName = 'vhc-${guid(virtualHubResourceIdChecked, virtualNetworkName, virtualNetworkResourceGroupName, virtualNetworkLocation, subscriptionId)}'

Instead we could have 'cn' for connection and the name could be as simple as this:

var virtualWanHubConnectionName = 'cn-${virtualNetworkName}'

(Optional) Correlation Id

No response

@noopman noopman added Needs: Triage 🔍 Maintainers need to triage still Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue labels Aug 22, 2024

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

Copy link

@noopman, thanks for submitting this issue for the avm/ptn/lz/sub-vending module!

Important

A member of the @Azure/avm-ptn-lz-subvending-module-owners-bicep or @Azure/avm-ptn-lz-subvending-module-contributors-bicep team will review it soon!

@avm-team-linter avm-team-linter bot added the Class: Pattern Module 📦 This is a pattern module label Aug 22, 2024
@sebassem
Copy link
Contributor

Thanks for submitting this issue, we are looking into how to better handle this

Warning

Tagging the AVM Core Team (@Azure/avm-core-team-technical-bicep) due to a module owner or contributor having not responded to this issue within 3 business days. The AVM Core Team will attempt to contact the module owners/contributors directly.

Tip

  • To prevent further actions to take effect, the "Status: Response Overdue 🚩" label must be removed, once this issue has been responded to.
  • To avoid this rule being (re)triggered, the ""Needs: Triage 🔍" label must be removed as part of the triage process (when the issue is first responded to)!

@microsoft-github-policy-service microsoft-github-policy-service bot added the Status: Response Overdue 🚩 When an issue/PR has not been responded to for X amount of days label Sep 3, 2024
@sebassem sebassem added Status: In PR 👉 This is when an issue is due to be fixed in an open PR and removed Needs: Triage 🔍 Maintainers need to triage still Status: Response Overdue 🚩 When an issue/PR has not been responded to for X amount of days labels Sep 3, 2024
jianingwang123 pushed a commit to jianingwang123/bicep-registry-modules that referenced this issue Sep 12, 2024
…s naming convention (Azure#3110)

## Description

Fixes Azure#3085 
<!--
>Thank you for your contribution !
> Please include a summary of the change and which issue is fixed.
> Please also include the context.
> List any dependencies that are required for this change.

Fixes Azure#123
Fixes Azure#456
Closes Azure#123
Closes Azure#456
-->

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.ptn.lz.sub-vending](https://github.com/sebassem/bicep-registry-modules/actions/workflows/avm.ptn.lz.sub-vending.yml/badge.svg?branch=avm-ptn-lz-sub-vending-vwan-connection-name)](https://github.com/sebassem/bicep-registry-modules/actions/workflows/avm.ptn.lz.sub-vending.yml)
|

## Type of Change

<!-- Use the checkboxes [x] on the options that are relevant. -->

- [ ] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [X] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [X] I'm sure there are no other open Pull Requests for the same
update/change
- [X] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [X] My corresponding pipelines / checks run clean and green without
any errors or warnings

<!-- Please keep up to date with the contribution guide at
https://aka.ms/avm/contribute/bicep -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Class: Pattern Module 📦 This is a pattern module Status: In PR 👉 This is when an issue is due to be fixed in an open PR Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue Type: Feature Request ➕ New feature or request
Projects
3 participants