Skip to content

Commit e690dd6

Browse files
lamchesterlamchester
committed
Update help for Set-AzureRmVirtualNetworkGateway
1 parent 01d9ba7 commit e690dd6

File tree

2 files changed

+319
-1
lines changed

2 files changed

+319
-1
lines changed

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

Lines changed: 318 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25658,6 +25658,324 @@ Subnets : []</dev:code>
2565825658
</maml:relatedLinks>
2565925659
</command:command>
2566025660
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
25661+
<!--Generated by PS Cmdlet Help Editor-->
25662+
<command:details>
25663+
<command:name>Set-AzureRmVirtualNetworkGateway</command:name>
25664+
<maml:description>
25665+
<maml:para>Updates a virtual network gateway</maml:para>
25666+
</maml:description>
25667+
<maml:copyright>
25668+
<maml:para />
25669+
</maml:copyright>
25670+
<command:verb>Set</command:verb>
25671+
<command:noun>AzureRmVirtualNetworkGateway</command:noun>
25672+
<dev:version />
25673+
</command:details>
25674+
<maml:description>
25675+
<maml:para />
25676+
</maml:description>
25677+
<command:syntax>
25678+
<command:syntaxItem>
25679+
<maml:name>Set-AzureRmVirtualNetworkGateway</maml:name>
25680+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
25681+
<maml:name>VirtualNetworkGateway</maml:name>
25682+
<maml:description>
25683+
<maml:para>The virtual network gateway object to base modifications off of. This can be retrieved using Get-AzureRmVirtualNetworkGateway</maml:para>
25684+
</maml:description>
25685+
<command:parameterValue required="true" variableLength="false">PSVirtualNetworkGateway</command:parameterValue>
25686+
</command:parameter>
25687+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25688+
<maml:name>GatewaySku</maml:name>
25689+
<maml:description>
25690+
<maml:para>The virtual network gateway's SKU</maml:para>
25691+
</maml:description>
25692+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
25693+
</command:parameter>
25694+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25695+
<maml:name>GatewayDefaultSite</maml:name>
25696+
<maml:description>
25697+
<maml:para>The default site to use for force tunneling. If a default site is specified, all internet traffic from the gateway's vnet is routed to that site.</maml:para>
25698+
</maml:description>
25699+
<command:parameterValue required="true" variableLength="false">PSLocalNetworkGateway</command:parameterValue>
25700+
</command:parameter>
25701+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25702+
<maml:name>VpnClientAddressPool</maml:name>
25703+
<maml:description>
25704+
<maml:para>The address space to allocate VPN client IP addresses from. This should not overlap with virtual network or on-premise ranges.</maml:para>
25705+
</maml:description>
25706+
<command:parameterValue required="true" variableLength="true">List`1[String]</command:parameterValue>
25707+
</command:parameter>
25708+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25709+
<maml:name>VpnClientRootCertificates</maml:name>
25710+
<maml:description>
25711+
<maml:para>A list of VPN client root certificates to use for VPN client authentication. Connecting VPN clients must present certificates generated from one of these root certificates.</maml:para>
25712+
</maml:description>
25713+
<command:parameterValue required="true" variableLength="true">List`1[PSVpnClientRootCertificate]</command:parameterValue>
25714+
</command:parameter>
25715+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25716+
<maml:name>VpnClientRevokedCertificates</maml:name>
25717+
<maml:description>
25718+
<maml:para>A list of revoked VPN client certificates. A VPN client presenting a certificate that matches one of these will be told to go away.</maml:para>
25719+
</maml:description>
25720+
<command:parameterValue required="true" variableLength="true">List`1[PSVpnClientRevokedCertificate]</command:parameterValue>
25721+
</command:parameter>
25722+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25723+
<maml:name>Asn</maml:name>
25724+
<maml:description>
25725+
<maml:para>The virtual network gateway's ASN, used to set up BGP sessions inside IPsec tunnels</maml:para>
25726+
</maml:description>
25727+
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
25728+
</command:parameter>
25729+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25730+
<maml:name>PeerWeight</maml:name>
25731+
<maml:description>
25732+
<maml:para>The weight added to routes learned over BGP from this virtual network gateway</maml:para>
25733+
</maml:description>
25734+
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
25735+
</command:parameter>
25736+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25737+
<maml:name>Tag</maml:name>
25738+
<maml:description>
25739+
<maml:para />
25740+
</maml:description>
25741+
<command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue>
25742+
</command:parameter>
25743+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
25744+
<maml:name>Force</maml:name>
25745+
<maml:description>
25746+
<maml:para />
25747+
</maml:description>
25748+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
25749+
</command:parameter>
25750+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
25751+
<maml:name>InformationAction</maml:name>
25752+
<maml:description>
25753+
<maml:para />
25754+
</maml:description>
25755+
<command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
25756+
</command:parameter>
25757+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
25758+
<maml:name>InformationVariable</maml:name>
25759+
<maml:description>
25760+
<maml:para />
25761+
</maml:description>
25762+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
25763+
</command:parameter>
25764+
</command:syntaxItem>
25765+
</command:syntax>
25766+
<command:parameters>
25767+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
25768+
<maml:name>VirtualNetworkGateway</maml:name>
25769+
<maml:description>
25770+
<maml:para>The virtual network gateway object to base modifications off of. This can be retrieved using Get-AzureRmVirtualNetworkGateway</maml:para>
25771+
</maml:description>
25772+
<command:parameterValue required="true" variableLength="false">PSVirtualNetworkGateway</command:parameterValue>
25773+
</command:parameter>
25774+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25775+
<maml:name>GatewaySku</maml:name>
25776+
<maml:description>
25777+
<maml:para>The virtual network gateway's SKU.</maml:para>
25778+
</maml:description>
25779+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
25780+
<dev:type>
25781+
<maml:name>String</maml:name>
25782+
<maml:uri/>
25783+
</dev:type>
25784+
<dev:defaultValue></dev:defaultValue>
25785+
</command:parameter>
25786+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25787+
<maml:name>GatewayDefaultSite</maml:name>
25788+
<maml:description>
25789+
<maml:para>The default site to use for force tunneling. If a default site is specified, all internet traffic from the gateway's vnet is routed to that site.</maml:para>
25790+
</maml:description>
25791+
<command:parameterValue required="true" variableLength="false">PSLocalNetworkGateway</command:parameterValue>
25792+
<dev:type>
25793+
<maml:name>PSLocalNetworkGateway</maml:name>
25794+
<maml:uri/>
25795+
</dev:type>
25796+
<dev:defaultValue></dev:defaultValue>
25797+
</command:parameter>
25798+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25799+
<maml:name>VpnClientAddressPool</maml:name>
25800+
<maml:description>
25801+
<maml:para>The address space to allocate VPN client IP addresses from. This should not overlap with virtual network or on-premise ranges.</maml:para>
25802+
</maml:description>
25803+
<command:parameterValue required="true" variableLength="true">List`1[String]</command:parameterValue>
25804+
<dev:type>
25805+
<maml:name>List`1[String]</maml:name>
25806+
<maml:uri/>
25807+
</dev:type>
25808+
<dev:defaultValue></dev:defaultValue>
25809+
</command:parameter>
25810+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25811+
<maml:name>VpnClientRootCertificates</maml:name>
25812+
<maml:description>
25813+
<maml:para>A list of VPN client root certificates to use for VPN client authentication. Connecting VPN clients must present certificates generated from one of these root certificates.</maml:para>
25814+
</maml:description>
25815+
<command:parameterValue required="true" variableLength="true">List`1[PSVpnClientRootCertificate]</command:parameterValue>
25816+
<dev:type>
25817+
<maml:name>List`1[PSVpnClientRootCertificate]</maml:name>
25818+
<maml:uri/>
25819+
</dev:type>
25820+
<dev:defaultValue></dev:defaultValue>
25821+
</command:parameter>
25822+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25823+
<maml:name>VpnClientRevokedCertificates</maml:name>
25824+
<maml:description>
25825+
<maml:para>A list of revoked VPN client certificates. A VPN client presenting a certificate that matches one of these will be told to go away.</maml:para>
25826+
</maml:description>
25827+
<command:parameterValue required="true" variableLength="true">List`1[PSVpnClientRevokedCertificate]</command:parameterValue>
25828+
<dev:type>
25829+
<maml:name>List`1[PSVpnClientRevokedCertificate]</maml:name>
25830+
<maml:uri/>
25831+
</dev:type>
25832+
<dev:defaultValue></dev:defaultValue>
25833+
</command:parameter>
25834+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25835+
<maml:name>Asn</maml:name>
25836+
<maml:description>
25837+
<maml:para>The virtual network gateway's ASN, used to set up BGP sessions inside IPsec tunnels</maml:para>
25838+
</maml:description>
25839+
<command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
25840+
<dev:type>
25841+
<maml:name>UInt32</maml:name>
25842+
<maml:uri/>
25843+
</dev:type>
25844+
<dev:defaultValue></dev:defaultValue>
25845+
</command:parameter>
25846+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25847+
<maml:name>PeerWeight</maml:name>
25848+
<maml:description>
25849+
<maml:para>The weight added to routes learned over BGP from this virtual network gateway</maml:para>
25850+
</maml:description>
25851+
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
25852+
<dev:type>
25853+
<maml:name>Int32</maml:name>
25854+
<maml:uri/>
25855+
</dev:type>
25856+
<dev:defaultValue></dev:defaultValue>
25857+
</command:parameter>
25858+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
25859+
<maml:name>Tag</maml:name>
25860+
<maml:description>
25861+
<maml:para />
25862+
</maml:description>
25863+
<command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue>
25864+
<dev:type>
25865+
<maml:name>Hashtable[]</maml:name>
25866+
<maml:uri/>
25867+
</dev:type>
25868+
<dev:defaultValue>none</dev:defaultValue>
25869+
</command:parameter>
25870+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
25871+
<maml:name>Force</maml:name>
25872+
<maml:description>
25873+
<maml:para />
25874+
</maml:description>
25875+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
25876+
<dev:type>
25877+
<maml:name>SwitchParameter</maml:name>
25878+
<maml:uri/>
25879+
</dev:type>
25880+
<dev:defaultValue>none</dev:defaultValue>
25881+
</command:parameter>
25882+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
25883+
<maml:name>InformationAction</maml:name>
25884+
<maml:description>
25885+
<maml:para />
25886+
</maml:description>
25887+
<command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
25888+
<dev:type>
25889+
<maml:name>ActionPreference</maml:name>
25890+
<maml:uri/>
25891+
</dev:type>
25892+
<dev:defaultValue></dev:defaultValue>
25893+
</command:parameter>
25894+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
25895+
<maml:name>InformationVariable</maml:name>
25896+
<maml:description>
25897+
<maml:para />
25898+
</maml:description>
25899+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
25900+
<dev:type>
25901+
<maml:name>String</maml:name>
25902+
<maml:uri/>
25903+
</dev:type>
25904+
<dev:defaultValue></dev:defaultValue>
25905+
</command:parameter>
25906+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
25907+
<maml:name>Profile</maml:name>
25908+
<maml:description>
25909+
<maml:para />
25910+
</maml:description>
25911+
<command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue>
25912+
<dev:type>
25913+
<maml:name>azureprofile</maml:name>
25914+
<maml:uri/>
25915+
</dev:type>
25916+
<dev:defaultValue>none</dev:defaultValue>
25917+
</command:parameter>
25918+
</command:parameters>
25919+
<command:inputTypes>
25920+
<command:inputType>
25921+
<dev:type>
25922+
<maml:name></maml:name>
25923+
<maml:uri></maml:uri>
25924+
<maml:description/>
25925+
</dev:type>
25926+
<maml:description>
25927+
<maml:para>
25928+
</maml:para>
25929+
</maml:description>
25930+
</command:inputType>
25931+
</command:inputTypes>
25932+
<command:returnValues>
25933+
<command:returnValue>
25934+
<dev:type>
25935+
<maml:name></maml:name>
25936+
<maml:uri></maml:uri>
25937+
<maml:description/>
25938+
</dev:type>
25939+
<maml:description>
25940+
<maml:para>
25941+
</maml:para>
25942+
</maml:description>
25943+
</command:returnValue>
25944+
</command:returnValues>
25945+
<command:terminatingErrors></command:terminatingErrors>
25946+
<command:nonTerminatingErrors></command:nonTerminatingErrors>
25947+
<maml:alertSet>
25948+
<maml:title></maml:title>
25949+
<maml:alert>
25950+
<maml:para>Keywords: azure, azurerm, arm, resource, management, manager, network, networking</maml:para>
25951+
</maml:alert>
25952+
</maml:alertSet>
25953+
<command:examples>
25954+
<command:example>
25955+
<maml:title>-------------------------- 1: --------------------------</maml:title>
25956+
<maml:introduction>
25957+
<maml:paragraph>Update a virtual network gateway's ASN</maml:paragraph>
25958+
</maml:introduction>
25959+
<dev:code>
25960+
PS C:\&gt; $gw = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "testrg" -Name "gw1"
25961+
PS C:\&gt; Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $gw -Asn 1337
25962+
</dev:code>
25963+
<dev:remarks>
25964+
<maml:para>Set-AzureRmVirtualNetworkGateway is used to set a new, complete goal state for the virtual network gateway. Make sure the snapshot of
25965+
the virtual network gateway state you're working with is up to date.</maml:para>
25966+
</dev:remarks>
25967+
<command:commandLines>
25968+
<command:commandLine>
25969+
<command:commandText>
25970+
</command:commandText>
25971+
</command:commandLine>
25972+
</command:commandLines>
25973+
</command:example>
25974+
</command:examples>
25975+
<maml:relatedLinks>
25976+
</maml:relatedLinks>
25977+
</command:command>
25978+
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
2566125979
<!--Generated by PS Cmdlet Help Editor-->
2566225980
<command:details>
2566325981
<command:name>New-AzureRmVirtualNetworkGatewayConnection</command:name>

‎src/ResourceManager/Network/Commands.Network/VirtualNetworkGateway/UpdateAzureVirtualNetworkGatewayCommand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class SetAzureVirtualNetworkGatewayCommand : VirtualNetworkGatewayBaseCmd
3030
[Parameter(
3131
Mandatory = true,
3232
ValueFromPipeline = true,
33-
HelpMessage = "The virtual network gateway base modifications off of. This can be retrieved using Get-AzureRmVirtualNetworkGateway")]
33+
HelpMessage = "The virtual network gateway object to base modifications off of. This can be retrieved using Get-AzureRmVirtualNetworkGateway")]
3434
public PSVirtualNetworkGateway VirtualNetworkGateway { get; set; }
3535

3636
[Parameter(

0 commit comments

Comments
 (0)