Skip to content

Commit b8324dd

Browse files
allegradomelwyunchi-ms
authored andcommitted
Add Examples Using Service Tags and Add Description to Parameter (#14630)
* Updated Example and Parameter Description Updated Example and Parameter Description with new Service Tag info * Added info on new Service Tag functionality Added example and updated parameter descriptions * Updating Command with Service Tag functionality Added example and edited parameter to explain how Service Tags can be used as address prefixes
1 parent 2999dc1 commit b8324dd

File tree

3 files changed

+28
-3
lines changed

3 files changed

+28
-3
lines changed

src/Network/Network/help/Add-AzRouteConfig.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,21 @@ This command gets the route table named RouteTable01 by using **Get-AzRouteTable
8484
The command passes that table to the current cmdlet by using the pipeline operator.
8585
The current cmdlet adds the route named Route02, and then passes the result to the **Set-AzRouteTable** cmdlet, which updates the table to reflect your changes.
8686

87+
### Example 3: Add a route with a Service Tag to a route table (Public Preview)
88+
```powershell
89+
PS C:\>$RouteTable = Get-AzRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01"
90+
PS C:\> Add-AzRouteConfig -Name "Route13" -AddressPrefix "AppService" -NextHopType "VirtualAppliance" -NextHopIpAddress "10.0.2.4" -RouteTable $RouteTable
91+
```
92+
93+
The first command gets a route table named RouteTable01 by using the Get-AzRouteTable cmdlet.
94+
The command stores the table in the $RouteTable variable.
95+
The second command adds a route named Route13 to the route table stored in $RouteTable.
96+
This route forwards traffic to IP prefixes contained in the AppService Service Tag to a virtual appliance.
97+
8798
## PARAMETERS
8899

89100
### -AddressPrefix
90-
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies.
101+
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. You can also specify a Service Tag here (this feature is in Public Preview).
91102

92103
```yaml
93104
Type: System.String

src/Network/Network/help/New-AzRouteConfig.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,17 @@ Creates a route for a route table. (autogenerated)
5050
New-AzRouteConfig -AddressPrefix 10.1.0.0/16 -Name 'Route07' -NextHopIpAddress '12.0.0.5' -NextHopType 'VnetLocal'
5151
```
5252

53+
### Example 3: Create a route with a Service Tag (Public Preview)
54+
```powershell
55+
New-AzRouteConfig -Name "Route07" -AddressPrefix "AppService" -NextHopType "VirtualAppliance" -NextHopIpAddress "10.0.2.4"
56+
```
57+
58+
This command creates a route named Route07 which forwards traffic to IP prefixes contained in the AppService Service Tag to a virtual appliance.
59+
5360
## PARAMETERS
5461

5562
### -AddressPrefix
56-
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies.
63+
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. You can also specify a Service Tag here (this feature is in Public Preview).
5764

5865
```yaml
5966
Type: System.String

src/Network/Network/help/Set-AzRouteConfig.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,17 @@ This command gets the route table named RouteTable01 by using the Get-AzRouteTab
6464
The command passes that table to the current cmdlet by using the pipeline operator.
6565
The current cmdlet modifies the route named Route02, and then passes the result to the **Set-AzRouteTable** cmdlet, which updates the table to reflect your changes.
6666

67+
### Example 2: Modify a route using a Service Tag (Public Preview)
68+
```powershell
69+
Set-AzRouteConfig -Name "Route02" -AddressPrefix "AppService" -NextHopType "VirtualAppliance" -NextHopIpAddress "10.0.2.4"
70+
```
71+
72+
This command modifies the route named Route02, supplying a Service Tag as the AddressPrefix parameter.
73+
6774
## PARAMETERS
6875

6976
### -AddressPrefix
70-
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies.
77+
Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. You can also specify a Service Tag here (this feature is in Public Preview).
7178

7279
```yaml
7380
Type: System.String

0 commit comments

Comments
 (0)