Skip to content

Commit f988a26

Browse files
author
anavinahar
committed
PeeringState update
1 parent 393e10a commit f988a26

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

src/ResourceManager/Network/Commands.Network/Microsoft.Azure.Commands.Network.dll-Help.xml

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,8 @@
169169
<maml:description/>
170170
</dev:type>
171171
<maml:description>
172-
<maml:para>System.String</maml:para>
172+
<maml:para>
173+
System.String</maml:para>
173174
</maml:description>
174175
</command:inputType>
175176
</command:inputTypes>
@@ -7185,8 +7186,7 @@ Subnets : []</dev:code>
71857186
<dev:code>PS C:\&gt; $vnet1 = Get-AzureRmVirtualNetwork –ResourceGroupName “MyResourceGroup” -Name vnet1
71867187
PS C:\&gt; $vnet2 = Get-AzureRmVirtualNetwork -ResourceGroupName “MyResourceGroup” -Name vnet2
71877188
PS C:\&gt; Add-AzureRmVirtualNetworkPeering -Name LinkToVNet2 -VirtualNetwork “MyVirtualNetwork” -RemoteVirtualNetworkId $vnet2.id
7188-
PS C:\&gt; Add-AzureRmVirtualNetworkPeering -Name LinkToVNet1 -VirtualNetwork “MyVirtualNetwork” -RemoteVirtualNetworkId $vnet1.id
7189-
</dev:code>
7189+
PS C:\&gt; Add-AzureRmVirtualNetworkPeering -Name LinkToVNet1 -VirtualNetwork “MyVirtualNetwork” -RemoteVirtualNetworkId $vnet1.id</dev:code>
71907190
<dev:remarks>
71917191
<maml:para>The first command gets a virtual network object called vnet1 associated with resource group “MyResourceGroup”. Similarly, the second command gets a virtual network object called vnet2 associated with the same resource group. The third command then adds a Vnet peering link from vnet1 to vnet2. This link is named LinkToVnet2. Finally, the forth command adds a link from vnet2 to vnet1 called LinkToVnet1. Note that vnet1 and vnet2 are assumed to be previously created in this example. Note that a link must be created from vnet1 to vnet2 and vice versa in order for peering to work.</maml:para>
71927192
<maml:para />
@@ -7199,9 +7199,10 @@ Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxx
71997199
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
72007200
ResourceGroupName : MyResourceGroup
72017201
VirtualNetworkName : MyVirtualNetwork
7202+
PeeringState : Initiated
72027203
ProvisioningState : Succeeded
72037204
RemoteVirtualNetwork : {
7204-
&quot;Id&quot;: &quot;/subscriptions/XXX/resourceGroups/MyResourceGroup
7205+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/MyResourceGroup
72057206
/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork&quot;
72067207
}
72077208
AllowVirtualNetworkAccess : True
@@ -7214,14 +7215,15 @@ RemoteVirtualNetworkAddressSpace : null
72147215

72157216

72167217
Name : LinkToVNet1
7217-
Id : /subscriptions/XXXX/resourceGroups/MyResourceGroup/provi
7218+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/MyResourceGroup/provi
72187219
ders/Microsoft.Network/virtualNetworks/MyVirtualNetwork/virtualNetworkPeerings/LinkToVNet1
7219-
Etag : W/&quot;XXX&quot;
7220+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx&quot;
72207221
ResourceGroupName : MyResourceGroup
72217222
VirtualNetworkName : MyVirtualNetwork
7223+
PeeringState : Initiated
72227224
ProvisioningState : Succeeded
72237225
RemoteVirtualNetwork : {
7224-
&quot;Id&quot;: &quot;/subscriptions/XXX/resourceGroups/MyResourceGroup
7226+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/MyResourceGroup
72257227
/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork&quot;
72267228
}
72277229
AllowVirtualNetworkAccess : True
@@ -15954,12 +15956,11 @@ Subnets : [
1595415956
</maml:alertSet>
1595515957
<command:examples>
1595615958
<command:example>
15957-
<maml:title>-------------------------- Example 1 Get a peering between 2 virtual networks --------------------------</maml:title>
15959+
<maml:title>-------------------------- Example 1 Get a peering between 2 virtual networks --------------------------</maml:title>
1595815960
<maml:introduction>
1595915961
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1596015962
</maml:introduction>
15961-
<dev:code>PS C:\&gt; Get-AzureRmVirtualNetworkPeering -Name “LinkToVNet2” -VirtualNetwork “MyVirtualNetwork” -ResourceGroupName “MyResourceGroup”
15962-
</dev:code>
15963+
<dev:code>PS C:\&gt; Get-AzureRmVirtualNetworkPeering -Name “LinkToVNet2” -VirtualNetwork “MyVirtualNetwork” -ResourceGroupName “MyResourceGroup”</dev:code>
1596315964
<dev:remarks>
1596415965
<maml:para>This command gets a previously created Virtual Network Peering called “LinkToVNet2” located in “MyVirtualNetwork” within the resource group called “MyResourceGroup”</maml:para>
1596515966
<maml:para />
@@ -15975,7 +15976,7 @@ Subnets : [
1597515976
</command:commandLines>
1597615977
</command:example>
1597715978
<command:example>
15978-
<maml:title>-------------------------- --------------------------</maml:title>
15979+
<maml:title>-------------------------- Unknown --------------------------</maml:title>
1597915980
<maml:introduction>
1598015981
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1598115982
</maml:introduction>
@@ -36611,11 +36612,9 @@ Remove-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResou
3661136612
<maml:introduction>
3661236613
<maml:paragraph>PS C:\&gt;</maml:paragraph>
3661336614
</maml:introduction>
36614-
<dev:code>PS C:\&gt; Remove-AzureRmVirtualNetworkPeering -Name “LinkToVNet2” -VirtualNetworkName “MyVirtualNetwork” -ResourceGroupName “MyResourceGroup”
36615-
</dev:code>
36615+
<dev:code>PS C:\&gt; Remove-AzureRmVirtualNetworkPeering -Name “LinkToVNet2” -VirtualNetworkName “MyVirtualNetwork” -ResourceGroupName “MyResourceGroup”</dev:code>
3661636616
<dev:remarks>
36617-
<maml:para>This command deletes a previously created Virtual Network Peering called “LinkToVNet2” located in “MyVirtualNetwork” within the resource group called “MyResourceGroup”
36618-
</maml:para>
36617+
<maml:para>This command deletes a previously created Virtual Network Peering called “LinkToVNet2” located in “MyVirtualNetwork” within the resource group called “MyResourceGroup”</maml:para>
3661936618
<maml:para />
3662036619
<maml:para />
3662136620
<maml:para></maml:para>
@@ -47130,8 +47129,7 @@ PS C:\&gt; Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $gw -Asn 1337
4713047129
</maml:introduction>
4713147130
<dev:code>PS C:\&gt; $LinkToVNet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName “MyVirtualNetwork” ResourceGroupName “MyResourceGroup” -Name LinkToVNet2
4713247131
PS C:\&gt; $LinkToVNet2.AllowForwardedTraffic = $true
47133-
PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2
47134-
</dev:code>
47132+
PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2</dev:code>
4713547133
<dev:remarks>
4713647134
<maml:para>This example shows how to change the forwarded traffic configuration to true instead of the default false option on a previously established VNet peering link. The first command gets the associated information regarding the link, in this case, called LinkToVNet2 within “MyResourceGroup” in virtual network “MyVirtualNetwork”. The next command updates the variable property to true. The final command changes the setting for the “LinkToVNet2” virtual network peering link to true.</maml:para>
4713747135
<maml:para />
@@ -47153,8 +47151,7 @@ PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2
4715347151
</maml:introduction>
4715447152
<dev:code>PS C:\&gt; $LinkToVNet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName “MyVirtualNetwork” ResourceGroupName “MyResourceGroup” -Name LinkToVNet2
4715547153
PS C:\&gt; $LinkToVNet2.AllowVirtualNetworkAccess = $false
47156-
PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2
47157-
</dev:code>
47154+
PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2</dev:code>
4715847155
<dev:remarks>
4715947156
<maml:para>This example shows how to change the Virtual Network Access property configuration to false instead of the default true option on a previously established VNet peering link. The first command gets the associated information regarding the link, in this case, called LinkToVNet2 within “MyResourceGroup” in virtual network “MyVirtualNetwork”. The next command updates the variable associated with the property to false. The final command changes the setting for the “LinkToVNet2” virtual network peering link to false.</maml:para>
4716047157
<maml:para />
@@ -47176,8 +47173,7 @@ PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2
4717647173
</maml:introduction>
4717747174
<dev:code>PS C:\&gt; $LinkToVNet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName “MyVirtualNetwork” ResourceGroupName “MyResourceGroup” -Name LinkToVNet2
4717847175
PS C:\&gt; $LinkToVNet2.AllowGatewayTransit = $true
47179-
PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2
47180-
</dev:code>
47176+
PS C:\&gt; Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2</dev:code>
4718147177
<dev:remarks>
4718247178
<maml:para>This example shows how to change the gateway transit property configuration to true instead of the default false option on a previously established VNet peering link. The first command gets the associated information regarding the link, in this case, called LinkToVNet2 within “MyResourceGroup” in virtual network “MyVirtualNetwork”. The next command updates the variable associated with this property to true. The final command changes the setting for the “LinkToVNet2” virtual network peering link to true. By changing this property to true, the peer VNet is allowed to use your VNet gateway.</maml:para>
4718347179
<maml:para />

0 commit comments

Comments
 (0)