Skip to content

Commit ad90654

Browse files
author
anavinahar
committed
LB examples update
1 parent b6e2ffa commit ad90654

File tree

1 file changed

+121
-23
lines changed

1 file changed

+121
-23
lines changed

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

Lines changed: 121 additions & 23 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>
@@ -5171,10 +5170,9 @@ 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></dev:code>
51765174
<dev:remarks>
5177-
<maml:para>The first command gets the load balancer named myLb, and then stores it in the $Lb variable.</maml:para>
5175+
<maml:para />
51785176
<maml:para />
51795177
<maml:para />
51805178
<maml:para></maml:para>
@@ -5954,10 +5952,9 @@ PS C:\&gt; $Lb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;natRule
59545952
<maml:introduction>
59555953
<maml:paragraph>PS C:\&gt;</maml:paragraph>
59565954
</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>
5955+
<dev:code></dev:code>
59595956
<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>
5957+
<maml:para />
59615958
<maml:para />
59625959
<maml:para />
59635960
<maml:para></maml:para>
@@ -13234,16 +13231,44 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1323413231
</maml:alertSet>
1323513232
<command:examples>
1323613233
<command:example>
13237-
<maml:title>-------------------------- 1: --------------------------</maml:title>
13234+
<maml:title>-------------------------- Example 1 Getting the frontend IP Configuration of an existing load balancer --------------------------</maml:title>
1323813235
<maml:introduction>
1323913236
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1324013237
</maml:introduction>
13241-
<dev:code></dev:code>
13238+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
13239+
13240+
PS C:\&gt; Get-AzureRmLoadBalancerFrontendIpConfig -Name &quot;MyFrontEnd&quot; -LoadBalancer $slb</dev:code>
1324213241
<dev:remarks>
13242+
<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>
1324313243
<maml:para />
1324413244
<maml:para />
13245-
<maml:para />
13246-
<maml:para></maml:para>
13245+
<maml:para>Name : MyFrontEnd
13246+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.
13247+
Network/loadBalancers/MyLoadBalancer/frontendIPConfigurations/MyFrontEnd
13248+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
13249+
ProvisioningState : Succeeded
13250+
PrivateIpAddress :
13251+
PrivateIpAllocationMethod : Dynamic
13252+
Subnet : null
13253+
PublicIpAddress : {
13254+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/M
13255+
icrosoft.Network/publicIPAddresses/MyPublicIP&quot;
13256+
}
13257+
InboundNatRules : [
13258+
{
13259+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers
13260+
/Microsoft.Network/loadBalancers/MyLoadBalancer/inboundNatRules/MyinboundNatRule1&quot;
13261+
},
13262+
13263+
}
13264+
]
13265+
LoadBalancingRules : [
13266+
{
13267+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers
13268+
/Microsoft.Network/loadBalancers/MyLoadBalancer/loadBalancingRules/MyLBruleName&quot;
13269+
}
13270+
]
13271+
InboundNatPools : []</maml:para>
1324713272
</dev:remarks>
1324813273
<command:commandLines>
1324913274
<command:commandLine>
@@ -13564,12 +13589,38 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1356413589
<maml:introduction>
1356513590
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1356613591
</maml:introduction>
13567-
<dev:code></dev:code>
13592+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
13593+
13594+
PS C:\&gt; Get-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;MyinboundNatRule1&quot; -LoadBalancer $slb
13595+
</dev:code>
1356813596
<dev:remarks>
13597+
<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>
13598+
<maml:para>Below is the sample output:</maml:para>
1356913599
<maml:para />
1357013600
<maml:para />
13571-
<maml:para />
13572-
<maml:para></maml:para>
13601+
<maml:para>Name : MyinboundNatRule1
13602+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/
13603+
providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inboundNatRules/Myinbound
13604+
NatRule1
13605+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
13606+
ProvisioningState : Succeeded
13607+
Protocol : Tcp
13608+
FrontendPort : 3389
13609+
BackendPort : 3389
13610+
IdleTimeoutInMinutes : 15
13611+
EnableFloatingIP : True
13612+
FrontendIPConfiguration : {
13613+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/
13614+
MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/frontendIPConfig
13615+
urations/MyFrontEnd&quot;
13616+
}
13617+
BackendIPConfiguration : {
13618+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/
13619+
MyResourceGroup/providers/Microsoft.Network/networkInterfaces/lb-nic1-be/ipConfigur
13620+
ations/ipconfig1&quot;,
13621+
&quot;Primary&quot;: false
13622+
}
13623+
</maml:para>
1357313624
</dev:remarks>
1357413625
<command:commandLines>
1357513626
<command:commandLine>
@@ -13747,16 +13798,38 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1374713798
</maml:alertSet>
1374813799
<command:examples>
1374913800
<command:example>
13750-
<maml:title>-------------------------- 1: --------------------------</maml:title>
13801+
<maml:title>-------------------------- Example 1 Getting probe configuration of an existing load balancer --------------------------</maml:title>
1375113802
<maml:introduction>
1375213803
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1375313804
</maml:introduction>
13754-
<dev:code></dev:code>
13805+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
13806+
13807+
PS C:\&gt; Get-AzureRmLoadBalancerProbeConfig -Name &quot;MyProbe&quot; -LoadBalancer $slb
13808+
</dev:code>
1375513809
<dev:remarks>
13810+
<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>
13811+
<maml:para>
13812+
Below is sample output:</maml:para>
1375613813
<maml:para />
1375713814
<maml:para />
13758-
<maml:para />
13759-
<maml:para></maml:para>
13815+
<maml:para>
13816+
Name : MyProbe
13817+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/provi
13818+
ders/Microsoft.Network/loadBalancers/MyLoadBalancer/probes/MyProbe
13819+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
13820+
ProvisioningState : Succeeded
13821+
Protocol : Http
13822+
Port : 80
13823+
IntervalInSeconds : 15
13824+
NumberOfProbes : 2
13825+
RequestPath : healthcheck.aspx
13826+
LoadBalancingRules : [
13827+
{
13828+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup
13829+
/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/loadBalancingRules/MyLBr
13830+
uleName&quot;
13831+
}
13832+
]</maml:para>
1376013833
</dev:remarks>
1376113834
<command:commandLines>
1376213835
<command:commandLine>
@@ -13934,16 +14007,41 @@ PS C:\&gt; Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name &quot;BackendAd
1393414007
</maml:alertSet>
1393514008
<command:examples>
1393614009
<command:example>
13937-
<maml:title>-------------------------- 1: --------------------------</maml:title>
14010+
<maml:title>-------------------------- Example 1 Gets the rule configuration of an existing load balancer --------------------------</maml:title>
1393814011
<maml:introduction>
1393914012
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1394014013
</maml:introduction>
13941-
<dev:code></dev:code>
14014+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name MyLoadBalancer -ResourceGroupName MyResourceGroup
14015+
14016+
PS C:\&gt; Get-AzureRmLoadBalancerRuleConfig -Name &quot;MyLBrulename&quot; -LoadBalancer $slb
14017+
</dev:code>
1394214018
<dev:remarks>
14019+
<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>
14020+
<maml:para>Below is sample output:</maml:para>
1394314021
<maml:para />
1394414022
<maml:para />
13945-
<maml:para />
13946-
<maml:para></maml:para>
14023+
<maml:para>Name : MyLBruleName
14024+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/provi
14025+
ders/Microsoft.Network/loadBalancers/MyLoadBalancer/probes/MyLBrulename
14026+
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
14027+
ProvisioningState : Succeeded
14028+
Protocol : Tcp
14029+
FrontendPort : 80
14030+
BackendPort : 80
14031+
IdleTimeoutInMinutes : 15
14032+
v : SourceIP
14033+
EnableFloatingIP : True
14034+
FrontendIPConfiguration : {
14035+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup
14036+
/providers/Microsoft.Network/loadBalancers/MyLoadBalancer//frontendIPConfig
14037+
urations/MyFrontEnd&quot;
14038+
}
14039+
BackendAddressPool :
14040+
Probe : {
14041+
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup
14042+
/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/probes/MyProbe&quot;
14043+
14044+
}</maml:para>
1394714045
</dev:remarks>
1394814046
<command:commandLines>
1394914047
<command:commandLine>

0 commit comments

Comments
 (0)