Skip to content

Commit 7214374

Browse files
markcowlmarkcowl
authored
Merge pull request Azure#2785 from anavinahar/helpUpdates
LB examples update
2 parents dcc2d36 + 918e50d commit 7214374

File tree

1 file changed

+107
-32
lines changed

1 file changed

+107
-32
lines changed

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

Lines changed: 107 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -403,8 +403,7 @@
403403
<maml:description/>
404404
</dev:type>
405405
<maml:description>
406-
<maml:para>
407-
System.String</maml:para>
406+
<maml:para>System.String</maml:para>
408407
</maml:description>
409408
</command:inputType>
410409
</command:inputTypes>
@@ -3835,7 +3834,7 @@ PS C:\&gt; $AppGW = Add-AzureRmApplicationGatewaySslCertificate -ApplicationGate
38353834
<dev:version />
38363835
</command:details>
38373836
<maml:description>
3838-
<maml:para>The Add-AzureRmLoadBalancerBackend cmdlet adds a backend address pool to an Azure load balancer.</maml:para>
3837+
<maml:para>The Add-AzureRmLoadBalancerBackend cmdlet adds a backend address pool to an Azure load balancer. This backend address pool contains network interfaces for the virtual machine to receive network traffic from the load balancer.</maml:para>
38393838
</maml:description>
38403839
<command:syntax>
38413840
<command:syntaxItem>
@@ -4026,7 +4025,7 @@ PS C:\&gt; $AppGW = Add-AzureRmApplicationGatewaySslCertificate -ApplicationGate
40264025
<dev:version />
40274026
</command:details>
40284027
<maml:description>
4029-
<maml:para>The Add-AzureRmLoadBalancerFrontendIpConifg cmdlet adds a front-end IP configuration to an Azure load balancer.</maml:para>
4028+
<maml:para>The Add-AzureRmLoadBalancerFrontendIpConifg cmdlet adds a front-end IP configuration to an Azure load balancer. This frontend IP configuration contains public IP addresses for incoming network traffic.</maml:para>
40304029
</maml:description>
40314030
<command:syntax>
40324031
<command:syntaxItem>
@@ -4835,7 +4834,7 @@ PS C:\&gt; Get-AzureRmLoadBalancer -Name &quot;myLB&quot; -ResourceGroupName &qu
48354834
<dev:version />
48364835
</command:details>
48374836
<maml:description>
4838-
<maml:para>The Add-AzureRmLoadBalancerInboundNatRuleConfig cmdlet adds an inbound network address translation (NAT) rule configuration to an Azure load balancer.</maml:para>
4837+
<maml:para>The Add-AzureRmLoadBalancerInboundNatRuleConfig cmdlet adds an inbound network address translation rule configuration to an Azure load balancer. This configuration contains rules mapping a public port on the load balancer to a port for a specific virtual machine in the backend address pool.</maml:para>
48394838
</maml:description>
48404839
<command:syntax>
48414840
<command:syntaxItem>
@@ -5171,13 +5170,45 @@ PS C:\&gt; Get-AzureRmLoadBalancer -Name &quot;myLB&quot; -ResourceGroupName &qu
51715170
<maml:introduction>
51725171
<maml:paragraph>PS C:\&gt;</maml:paragraph>
51735172
</maml:introduction>
5174-
<dev:code>PS C:\&gt;$Lb = Get-AzureRmLoadBalancer -Name &quot;myLb&quot; -ResourceGroupName &quot;myRg&quot;
5175-
PS C:\&gt; $Lb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;natRule&quot; -FrontendIPConfiguration$lb.Properties.FrontendIPConfigurations[0] -BackendIpConfiguration $Nic.Properties.IpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -IdleTimeoutInSeconds 17 -EnableFloatingIP | Set-AzureRmLoadBalancer</dev:code>
5173+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
5174+
5175+
PS C:\&gt; $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP</dev:code>
51765176
<dev:remarks>
5177-
<maml:para>The first command gets the load balancer named myLb, and then stores it in the $Lb variable.</maml:para>
5177+
<maml:para>The first command stores the existing load balancer called &quot;MyloadBalancer&quot; into a varibale called $slb. The second command then adds an Inbound NAT rule configuration with appropriate details. Note that these are chosen as an example and these may change based on one&#39;s loadbalancer.</maml:para>
51785178
<maml:para />
51795179
<maml:para />
5180-
<maml:para></maml:para>
5180+
<maml:para>Name : MyLoadBalancer
5181+
ResourceGroupName : MyResourceGroup
5182+
Location : westus
5183+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
5184+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
5185+
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
5186+
ProvisioningState : Succeeded
5187+
Tags :
5188+
FrontendIpConfigurations : []
5189+
BackendAddressPools : []
5190+
LoadBalancingRules : []
5191+
Probes : []
5192+
InboundNatRules : [
5193+
5194+
{
5195+
&quot;Name&quot;: &quot;NewNatRule&quot;,
5196+
&quot;Etag&quot;: &quot;W/\&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\&quot;&quot;,
5197+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
5198+
undNatRules/NewRule&quot;,
5199+
&quot;FrontendPort&quot;: 81,
5200+
&quot;IdleTimeoutInMinutes&quot;: 4,
5201+
&quot;EnableFloatingIP&quot;: true,
5202+
&quot;FrontendIPConfiguration&quot;: {
5203+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
5204+
ontendIPConfigurations/MyFrontEnd&quot;
5205+
},
5206+
&quot;BackendPort&quot;: 8181,
5207+
&quot;Protocol&quot;: &quot;Tcp&quot;,
5208+
&quot;ProvisioningState&quot;: &quot;Succeeded&quot;
5209+
}
5210+
]
5211+
InboundNatPools : []</maml:para>
51815212
</dev:remarks>
51825213
<command:commandLines>
51835214
<command:commandLine>
@@ -5230,7 +5261,7 @@ PS C:\&gt; $Lb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;natRule
52305261
<dev:version />
52315262
</command:details>
52325263
<maml:description>
5233-
<maml:para>The Add-AzureRmLoadBalancerProbeConfig cmdlet adds a probe configuration to an Azure load balancer.</maml:para>
5264+
<maml:para>The Add-AzureRmLoadBalancerProbeConfig cmdlet adds a probe configuration to an Azure load balancer. This contains health probes used to check availability of virtual machines instances in the backend address pool.</maml:para>
52345265
</maml:description>
52355266
<command:syntax>
52365267
<command:syntaxItem>
@@ -5516,7 +5547,7 @@ PS C:\&gt; $Lb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;natRule
55165547
<dev:version />
55175548
</command:details>
55185549
<maml:description>
5519-
<maml:para>The Add-AzureRmLoadBalancerRuleConfig cmdlet adds a rule configuration to an Azure load balancer.</maml:para>
5550+
<maml:para>The Add-AzureRmLoadBalancerRuleConfig cmdlet adds a rule configuration to an Azure load balancer. This rule configuration contains rules mapping a public port on the load balancer to a port in the back end address pool.</maml:para>
55205551
</maml:description>
55215552
<command:syntax>
55225553
<command:syntaxItem>
@@ -5954,10 +5985,11 @@ PS C:\&gt; $Lb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;natRule
59545985
<maml:introduction>
59555986
<maml:paragraph>PS C:\&gt;</maml:paragraph>
59565987
</maml:introduction>
5957-
<dev:code>PS C:\&gt;$LoadBalancer = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
5958-
PS C:\&gt; $LoadBalancer | Add-AzureRmLoadBalancerRuleConfig -Name &quot;LbRuleConfig&quot; -FrontendIPConfiguration $LoadBalancer.Properties.FrontendIPConfigurations[0] -BackendAddressPool $LoadBalancer.Properties.BackendAddressPools[0] -Probe $LoadBalancer.Properties.Probes[0] -Protocol &quot;Tcp&quot; -FrontendPort 80 -BackendPort 80 -IdleTimeoutInSeconds 15 -EnableFloatingIP | Set-AzureRmLoadBalancer</dev:code>
5988+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
5989+
5990+
PS C:\&gt; $slb | Add-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP</dev:code>
59595991
<dev:remarks>
5960-
<maml:para>The first command gets an existing load balancer named MyLoadBalancer, and then stores it in the $LoadBalancer variable. The second command adds a newly created rule configuration to this load balancer called &quot;LbRuleConfig&quot; with</maml:para>
5992+
<maml:para>The first command stores the existing load balancer called &quot;MyLoadBalancer&quot; in variable $slb. The second command then adds the rule called &quot;NewRule&quot; with certain specifications.</maml:para>
59615993
<maml:para />
59625994
<maml:para />
59635995
<maml:para></maml:para>
@@ -13234,16 +13266,44 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1323413266
</maml:alertSet>
1323513267
<command:examples>
1323613268
<command:example>
13237-
<maml:title>-------------------------- 1: --------------------------</maml:title>
13269+
<maml:title>-------------------------- Example 1 Getting the frontend IP Configuration of an existing load balancer --------------------------</maml:title>
1323813270
<maml:introduction>
1323913271
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1324013272
</maml:introduction>
13241-
<dev:code></dev:code>
13273+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
13274+
13275+
PS C:\&gt; Get-AzureRmLoadBalancerFrontendIpConfig -Name &quot;MyFrontEnd&quot; -LoadBalancer $slb</dev:code>
1324213276
<dev:remarks>
13277+
<maml:para>The first command gets the existing load balancer and stores it within the variable $slb. The second command then gets the front end IP configuration associated with that load balancer.</maml:para>
1324313278
<maml:para />
1324413279
<maml:para />
13245-
<maml:para />
13246-
<maml:para></maml:para>
13280+
<maml:para>Name : MyFrontEnd
13281+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.
13282+
Network/loadBalancers/MyLoadBalancer/frontendIPConfigurations/MyFrontEnd
13283+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
13284+
ProvisioningState : Succeeded
13285+
PrivateIpAddress :
13286+
PrivateIpAllocationMethod : Dynamic
13287+
Subnet : null
13288+
PublicIpAddress : {
13289+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/M
13290+
icrosoft.Network/publicIPAddresses/MyPublicIP&quot;
13291+
}
13292+
InboundNatRules : [
13293+
{
13294+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers
13295+
/Microsoft.Network/loadBalancers/MyLoadBalancer/inboundNatRules/MyinboundNatRule1&quot;
13296+
},
13297+
13298+
}
13299+
]
13300+
LoadBalancingRules : [
13301+
{
13302+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers
13303+
/Microsoft.Network/loadBalancers/MyLoadBalancer/loadBalancingRules/MyLBruleName&quot;
13304+
}
13305+
]
13306+
InboundNatPools : []</maml:para>
1324713307
</dev:remarks>
1324813308
<command:commandLines>
1324913309
<command:commandLine>
@@ -13564,9 +13624,11 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1356413624
<maml:introduction>
1356513625
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1356613626
</maml:introduction>
13567-
<dev:code></dev:code>
13627+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
13628+
13629+
PS C:\&gt; Get-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;MyinboundNatRule1&quot; -LoadBalancer $slb</dev:code>
1356813630
<dev:remarks>
13569-
<maml:para />
13631+
<maml:para>The first command gets the existing load balancer for which the inbound NAT rule is wanted and stores it in the variable slb. The second command then gets the accodiated NAT rule called MyinboundNatRule1.</maml:para>
1357013632
<maml:para />
1357113633
<maml:para />
1357213634
<maml:para></maml:para>
@@ -13747,13 +13809,15 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1374713809
</maml:alertSet>
1374813810
<command:examples>
1374913811
<command:example>
13750-
<maml:title>-------------------------- 1: --------------------------</maml:title>
13812+
<maml:title>-------------------------- Example 1 Getting probe configuration of an existing load balancer --------------------------</maml:title>
1375113813
<maml:introduction>
1375213814
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1375313815
</maml:introduction>
13754-
<dev:code></dev:code>
13816+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
13817+
13818+
PS C:\&gt; Get-AzureRmLoadBalancerProbeConfig -Name &quot;MyProbe&quot; -LoadBalancer $slb</dev:code>
1375513819
<dev:remarks>
13756-
<maml:para />
13820+
<maml:para>The first command gets the load balancer called &quot;MyLoadBalancer&quot; and stores it in the variable $slb. The second command then gets the associated probe configuration called MyProbe.</maml:para>
1375713821
<maml:para />
1375813822
<maml:para />
1375913823
<maml:para></maml:para>
@@ -13934,13 +13998,15 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1393413998
</maml:alertSet>
1393513999
<command:examples>
1393614000
<command:example>
13937-
<maml:title>-------------------------- 1: --------------------------</maml:title>
14001+
<maml:title>-------------------------- Example 1 Gets the rule configuration of an existing load balancer --------------------------</maml:title>
1393814002
<maml:introduction>
1393914003
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1394014004
</maml:introduction>
13941-
<dev:code></dev:code>
14005+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
14006+
14007+
PS C:\&gt; Get-AzureRmLoadBalancerRuleConfig -Name &quot;MyLBrulename&quot; -LoadBalancer $slb</dev:code>
1394214008
<dev:remarks>
13943-
<maml:para />
14009+
<maml:para>The first command gets the load balancer and stores it in the variable $slb. The second command gets the associated rule configuration called MyLBrulename.</maml:para>
1394414010
<maml:para />
1394514011
<maml:para />
1394614012
<maml:para></maml:para>
@@ -45151,13 +45217,17 @@ PS C:\&gt; $slb | Set-AzureRmLoadBalancerFrontendIpConfig -Name &quot;NewFronten
4515145217
</maml:alertSet>
4515245218
<command:examples>
4515345219
<command:example>
45154-
<maml:title>-------------------------- 1: --------------------------</maml:title>
45220+
<maml:title>-------------------------- Example 1 Updating the inbound NAT rule configuration on an existing load balancer --------------------------</maml:title>
4515545221
<maml:introduction>
4515645222
<maml:paragraph>PS C:\&gt;</maml:paragraph>
4515745223
</maml:introduction>
45158-
<dev:code></dev:code>
45224+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
45225+
45226+
PS C:\&gt; $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
45227+
45228+
PS C:\&gt; $slb | Set-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350</dev:code>
4515945229
<dev:remarks>
45160-
<maml:para />
45230+
<maml:para>The first command stores the existing load balancer called &quot;MyloadBalancer&quot; into a varibale called $slb. The second command then adds an Inbound NAT rule configuration with certain properties. One of these is enablibling floating IP. However once added, lets assume one no longer wants this properly enabled, then the third command is used to update this for the load balancer using the Set-AzureRmLoadBalancerInboundNatRuleConfig.</maml:para>
4516145231
<maml:para />
4516245232
<maml:para />
4516345233
<maml:para></maml:para>
@@ -45925,13 +45995,18 @@ PS C:\&gt; $slb | Set-AzureRmLoadBalancerProbeConfig -Name &quot;NewProbe&quot;
4592545995
</maml:alertSet>
4592645996
<command:examples>
4592745997
<command:example>
45928-
<maml:title>-------------------------- 1: --------------------------</maml:title>
45998+
<maml:title>-------------------------- Example 1 Updating a load balancing rule on an existing load balancer --------------------------</maml:title>
4592945999
<maml:introduction>
4593046000
<maml:paragraph>PS C:\&gt;</maml:paragraph>
4593146001
</maml:introduction>
45932-
<dev:code></dev:code>
46002+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
46003+
46004+
PS C:\&gt; $slb | $slb | Add-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
46005+
46006+
46007+
PS C:\&gt; $slb | Set-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350</dev:code>
4593346008
<dev:remarks>
45934-
<maml:para />
46009+
<maml:para>The first command stores an existing load balancer called MyLoadBalancer in the variable $slb. The second command adds a load balancing rule called NewRule with certain specifications. One of these is enabling floating IP to be true. However once added, lets assume one no longer wants this properly enabled, then the third command is used to update this for the load balancer using the Set-AzureRmLoadBalancerRuleConfig.</maml:para>
4593546010
<maml:para />
4593646011
<maml:para />
4593746012
<maml:para></maml:para>

0 commit comments

Comments
 (0)