Azure / Azure/azure-quickstart-templates

Document or re-design NSG addition template because it has no real-world use cases

Open
#11,313 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Bicep
Stars
14.9k
Forks
16.2k
Avg merge
6d 21h
Merged PRs (30d)
6

Description

[Add a subnet to an existing VNET](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.network/subnet-add-vnet-existing)

### Issue Details

The template does not only add a new NSG into the existing subnet. It also removes existing settings e.g. delegation and service endpoints.

The template also requires passing the existing subnet address prefix as part of the deployment.

Those two features make the pattern used on this template impractical for real-world usage and it should be documented.

### Repro steps (*if necessary, delete otherwise*)
1. Deploy template with existing pre-configured subnet
2. Existing subnet properties are removed

### Possible fixes

* Document template and potential real-world usage issues?
* Analyze and document if it would be better to use Azure CLI or Powershell to attach NSG with the existing subnet
* Analyze and document if deployment script should be used to run CLI tool to attach NSG with the existing subnet

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the quickstarts/microsoft.network/subnet-add-vnet-existing template and reproduce its deployment against a pre-configured subnet. Check how the deployment removes delegation and service endpoints and why the existing address prefix is required. Compare documenting these limitations with using Azure CLI, PowerShell, or a deployment script; done means recording the real-world use cases and a justified recommended approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cloud, infrastructure
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.