Skip to content

Commit c20707d

Browse files
committed
Added examples and descriptions
Added examples and descriptions for Add-AzureRmVirtualNetworkGatewayIpConfig, Get-AzureRmVirtualNetworkGatewayConnectionSharedKey and New-AzureRmVirtualNetworkGatewayConnection
1 parent e118edb commit c20707d

File tree

4 files changed

+62
-3
lines changed

4 files changed

+62
-3
lines changed

src/ResourceManager/Network/Commands.Network/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
* Updated all help files to include full parameter types and correct input/output types.
2323
* Added examples for LoadBalancerInboundNatPoolConfig cmdlets.
2424
* Added example for Set-AzureRmLocalNetworkGateway
25+
* Added examples and descriptions for Add-AzureRmVirtualNetworkGatewayIpConfig, Get-AzureRmVirtualNetworkGatewayConnectionSharedKey and New-AzureRmVirtualNetworkGatewayConnection
2526

2627
## Version 6.4.0
2728
* Updated below cmdlets for Application Gateway

src/ResourceManager/Network/Commands.Network/help/Add-AzureRmVirtualNetworkGatewayIpConfig.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,59 @@ Add-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetwor
3131
The **Add-AzureRmVirtualNetworkGatewayIpConfig** cmdlet adds an IP configuration to a virtual network gateway.
3232

3333
## EXAMPLES
34+
### Example 1
35+
```
36+
Add-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway $gw -Name GWIPConfig2 -Subnet $subnet -PublicIpAddress $gwpip2
37+
38+
39+
Name : VNet7GW
40+
ResourceGroupName : VPNGatewayV3
41+
Location : eastus
42+
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworkGateways/VNet7GW
43+
Etag : W/"d27a784f-3c3f-4150-863d-764649b6e8e7"
44+
ResourceGuid : 3c2478a7-d5d4-4e80-8532-7ea2ad577598
45+
ProvisioningState : Succeeded
46+
Tags :
47+
IpConfigurations : [
48+
{
49+
"PrivateIpAllocationMethod": "Dynamic",
50+
"Subnet": {
51+
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworks/Vnet7/subnets/GatewaySubnet"
52+
},
53+
"PublicIpAddress": {
54+
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/publicIPAddresses/VNet7GW_IP"
55+
},
56+
"Name": "default",
57+
"Etag": "W/\"d27a784f-3c3f-4150-863d-764649b6e8e7\"",
58+
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/virtualNetworkGateways/VNet7GW/ipConfigurations/default"
59+
},
60+
{
61+
"PrivateIpAllocationMethod": "Dynamic",
62+
"PublicIpAddress": {
63+
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VPNGatewayV3/providers/Microsoft.Network/publicIPAddresses/delIPConfig"
64+
},
65+
"Name": "GWIPConfig2",
66+
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupNotSet/providers/Microsoft.Network/virtualNetworkGateways/VirtualNetworkGatewayNameNotSet/virtualNetworkGatewayIpConfiguration/GWIPConfig2"
67+
}
68+
]
69+
GatewayType : Vpn
70+
VpnType : RouteBased
71+
EnableBgp : True
72+
ActiveActive : False
73+
GatewayDefaultSite : null
74+
Sku : {
75+
"Capacity": 2,
76+
"Name": "VpnGw1",
77+
"Tier": "VpnGw1"
78+
}
79+
VpnClientConfiguration : null
80+
BgpSettings : {
81+
"Asn": 65534,
82+
"BgpPeeringAddress": "10.7.255.254",
83+
"PeerWeight": 0
84+
}
85+
```
86+
3487

3588
## PARAMETERS
3689

src/ResourceManager/Network/Commands.Network/help/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ schema: 2.0.0
99
# Get-AzureRmVirtualNetworkGatewayConnectionSharedKey
1010

1111
## SYNOPSIS
12-
12+
Displays the shared key used for the connection.
1313
## SYNTAX
1414

1515
```
@@ -18,8 +18,13 @@ Get-AzureRmVirtualNetworkGatewayConnectionSharedKey [-Name <String>] -ResourceGr
1818
```
1919

2020
## DESCRIPTION
21-
21+
Displays the shared key used for the connection.
2222
## EXAMPLES
23+
### Example 1
24+
```
25+
Get-AzureRmVirtualNetworkGatewayConnectionSharedKey -Name 1 -ResourceGroupName P2SVPNGateway
26+
xxxxxx
27+
```
2328

2429
## PARAMETERS
2530

src/ResourceManager/Network/Commands.Network/help/New-AzureRmVirtualNetworkGatewayConnection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Creates the Site-to-Site VPN connection between the virtual network gateway and
4040

4141
## EXAMPLES
4242

43-
### 1:
43+
### Example 1
4444
```
4545
New-AzureRmVirtualNetworkGatewayConnection -Name conn-client-1 -ResourceGroupName $RG1 -VirtualNetworkGateway1 $vnetgw1 -VirtualNetworkGateway2 $vnetgw2 -Location $loc1 -ConnectionType Vnet2Vnet -SharedKey 'a1b2c3d4e5'
4646
```

0 commit comments

Comments
 (0)