Skip to content

Commit 1cf72ec

Browse files
Merge pull request #307861 from jl-ms/patch-41
Document UseExisting mode for AVNM UDR management
2 parents 45adba7 + 2099560 commit 1cf72ec

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

articles/virtual-network-manager/concept-user-defined-route.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,47 @@ Here are the common routing scenarios that you can simplify and automate by usin
115115
| hub and spoke network with Spoke network to on-premises needs to go via Network Virtual Appliance | |
116116
| Gateway -> Network Virtual Appliance -> Spoke network | |
117117

118+
## UseExisting Mode for AVNM UDR Management
119+
120+
### Overview
121+
**UseExisting mode** allows Azure Virtual Network Manager (AVNM) to append routes to an existing route table instead of creating a new one.
122+
This mode provides greater **control**, ensures **compliance with organizational policies**, and reduces **operational complexity** when customers need to preserve existing resource naming conventions, tags, or resource group structures.
123+
124+
**Comparison:**
125+
- **ManagedOnly (default):** AVNM always creates or reuses its own managed route table.
126+
- **UseExisting:** AVNM uses the existing subnet-associated route table, appending required routes while preserving its properties.
127+
128+
129+
130+
### Step-by-Step: Enable UseExisting Mode
131+
132+
#### 1. Enable via Portal or API
133+
1. Open the **AVNM portal** or use the **API**.
134+
2. Select your **routing configuration**.
135+
3. Set the **`routeTableUsageMode`** property to `UseExisting`.
136+
- If a route table already exists on the subnet, AVNM will **append** the required routes.
137+
- If no route table is present, AVNM will **create** one automatically.
138+
139+
#### 2. Switching Modes
140+
- You can switch between `ManagedOnly` and `UseExisting` at any time.
141+
- When switching **from ManagedOnly to UseExisting**, note that the existing route tables are **AVNM-managed**, so manual updates and reassociation may be required to align configurations.
142+
- When switching **from UseExisting to ManagedOnly**, remove any AVNM-created routes from the customer route tables. Reassociation is **not required** since AVNM will automatically manage the new route tables.
143+
144+
### Behavior
145+
146+
| Aspect | Description |
147+
|--------|--------------|
148+
| **Preservation** | Existing route table properties such as name, tags, and resource group are preserved. |
149+
| **Manual Changes** | AVNM does not track manual modifications. Any manual edits may lead to configuration drift. |
150+
| **Compliance** | AVNM respects Azure Policy, RBAC permissions, and resource locks. Ensure permissions allow updates. |
151+
| **Shared Tables** | If multiple subnets share a single route table, all will inherit AVNM routes—verify before enabling. |
152+
| **Subnet Associations** | AVNM does not automatically remove subnet associations from existing customer route tables. If a subnet is removed from the network group, its association remains intact, meaning the subnet will still be linked to the same route table. |
153+
154+
### Route Table Sharing and Cleanup Behavior
155+
When multiple subnets from different network groups share the same route table, unintended routes may appear, as AVNM does not track which subnet adds specific routes. Customers must manually remove or dissociate subnets if undesired routes occur.
156+
If any subnet enables properties such as `DisableBgpRoutePropagation`, those settings apply to the entire shared table. Routes remain in the table until all contributing subnets are unmanaged.
157+
When a subnet is removed from a network group, AVNM stops managing it but does not modify the existing table association. AVNM removes its routes only when no remaining managed subnets depend on them. Customer-created route tables are never deleted, even when left empty after cleanup.
158+
118159
## Adding other virtual networks
119160

120161
When you add other virtual networks to a network group, the routing configuration is automatically applied to the new virtual network. Your network manager automatically detects the new virtual network and applies the routing configuration to it. When you remove a virtual network from the network group, the applied routing configuration is automatically removed as well.

0 commit comments

Comments
 (0)