Skip to content

Commit 918e50d

Browse files
author
anavinahar
committed
LB cmdlet desc update
1 parent e2ec1d4 commit 918e50d

File tree

1 file changed

+15
-109
lines changed

1 file changed

+15
-109
lines changed

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

Lines changed: 15 additions & 109 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>
@@ -5173,8 +5172,7 @@ PS C:\&gt; Get-AzureRmLoadBalancer -Name &quot;myLB&quot; -ResourceGroupName &qu
51735172
</maml:introduction>
51745173
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
51755174

5176-
PS C:\&gt; $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
5177-
</dev:code>
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>
51785176
<dev:remarks>
51795177
<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>
51805178
<maml:para />
@@ -5210,8 +5208,7 @@ InboundNatRules : [
52105208
&quot;ProvisioningState&quot;: &quot;Succeeded&quot;
52115209
}
52125210
]
5213-
InboundNatPools : []
5214-
</maml:para>
5211+
InboundNatPools : []</maml:para>
52155212
</dev:remarks>
52165213
<command:commandLines>
52175214
<command:commandLine>
@@ -5264,7 +5261,7 @@ InboundNatPools : []
52645261
<dev:version />
52655262
</command:details>
52665263
<maml:description>
5267-
<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>
52685265
</maml:description>
52695266
<command:syntax>
52705267
<command:syntaxItem>
@@ -5550,7 +5547,7 @@ InboundNatPools : []
55505547
<dev:version />
55515548
</command:details>
55525549
<maml:description>
5553-
<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>
55545551
</maml:description>
55555552
<command:syntax>
55565553
<command:syntaxItem>
@@ -5988,43 +5985,14 @@ InboundNatPools : []
59885985
<maml:introduction>
59895986
<maml:paragraph>PS C:\&gt;</maml:paragraph>
59905987
</maml:introduction>
5991-
<dev:code>
5992-
PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
5988+
<dev:code>PS C:\&gt; $slb = Get-AzureRmLoadBalancer -Name &quot;MyLoadBalancer&quot; -ResourceGroupName &quot;MyResourceGroup&quot;
59935989

5994-
PS C:\&gt; $slb | Add-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
5995-
</dev:code>
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>
59965991
<dev:remarks>
59975992
<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>
5998-
<maml:para>Below is what sample output looks like for this specific scenario:</maml:para>
59995993
<maml:para />
60005994
<maml:para />
6001-
<maml:para>Name : MyLoadBalancer
6002-
ResourceGroupName : MyResourceGroup
6003-
Location : westus
6004-
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
6005-
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
6006-
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
6007-
ProvisioningState : Succeeded
6008-
Tags :
6009-
FrontendIpConfigurations : []
6010-
BackendAddressPools : []
6011-
LoadBalancingRules : [
6012-
&quot;Name&quot;: &quot;NewRule&quot;,
6013-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
6014-
undNatRules/NewRule&quot;,
6015-
&quot;FrontendPort&quot;: 3350,
6016-
&quot;EnableFloatingIP&quot;: true,
6017-
&quot;FrontendIPConfiguration&quot;: {
6018-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
6019-
ontendIPConfigurations/MyFrontEnd&quot;
6020-
},
6021-
&quot;BackendPort&quot;: 3350,
6022-
&quot;Protocol&quot;: &quot;Tcp&quot;
6023-
}
6024-
]
6025-
Probes : []
6026-
InboundNatRules : []
6027-
</maml:para>
5995+
<maml:para></maml:para>
60285996
</dev:remarks>
60295997
<command:commandLines>
60305998
<command:commandLine>
@@ -45257,44 +45225,12 @@ PS C:\&gt; $slb | Set-AzureRmLoadBalancerFrontendIpConfig -Name &quot;NewFronten
4525745225

4525845226
PS C:\&gt; $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
4525945227

45260-
PS C:\&gt; $slb | Set-AzureRmLoadBalancerInboundNatRuleConfig -Name &quot;NewNatRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 </dev:code>
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>
4526145229
<dev:remarks>
4526245230
<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>
45263-
<maml:para>Notice how the output below has -EnablePloatingIP to false even though when NewNatRule was added it was set to true. Similarly, other properties can be changed using this cmdlet.</maml:para>
4526445231
<maml:para />
4526545232
<maml:para />
45266-
<maml:para>Name : MyLoadBalancer
45267-
ResourceGroupName : MyResourceGroup
45268-
Location : westus
45269-
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
45270-
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
45271-
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
45272-
ProvisioningState : Succeeded
45273-
Tags :
45274-
FrontendIpConfigurations : []
45275-
BackendAddressPools : []
45276-
LoadBalancingRules : []
45277-
Probes : []
45278-
InboundNatRules : [
45279-
45280-
{
45281-
&quot;Name&quot;: &quot;NewNatRule&quot;,
45282-
&quot;Etag&quot;: &quot;W/\&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\&quot;&quot;,
45283-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
45284-
undNatRules/NewRule&quot;,
45285-
&quot;FrontendPort&quot;: 81,
45286-
&quot;IdleTimeoutInMinutes&quot;: 4,
45287-
&quot;EnableFloatingIP&quot;: false,
45288-
&quot;FrontendIPConfiguration&quot;: {
45289-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
45290-
ontendIPConfigurations/MyFrontEnd&quot;
45291-
},
45292-
&quot;BackendPort&quot;: 8181,
45293-
&quot;Protocol&quot;: &quot;Tcp&quot;,
45294-
&quot;ProvisioningState&quot;: &quot;Succeeded&quot;
45295-
}
45296-
]
45297-
InboundNatPools : []</maml:para>
45233+
<maml:para></maml:para>
4529845234
</dev:remarks>
4529945235
<command:commandLines>
4530045236
<command:commandLine>
@@ -46068,42 +46004,12 @@ PS C:\&gt; $slb | Set-AzureRmLoadBalancerProbeConfig -Name &quot;NewProbe&quot;
4606846004
PS C:\&gt; $slb | $slb | Add-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
4606946005

4607046006

46071-
PS C:\&gt; $slb | Set-AzureRmLoadBalancerRuleConfig -Name &quot;NewRule&quot; -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol &quot;Tcp&quot; -FrontendPort 3350 -BackendPort 3350
46072-
46073-
46074-
</dev:code>
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>
4607546008
<dev:remarks>
4607646009
<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>
46077-
<maml:para>Notice how the output below has -EnablePloatingIP to false even though when NewRule was added it was set to true. Similarly, other properties can be changed using this cmdlet.
46078-
</maml:para>
4607946010
<maml:para />
4608046011
<maml:para />
46081-
<maml:para>Name : MyLoadBalancer
46082-
ResourceGroupName : MyResourceGroup
46083-
Location : westus
46084-
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer
46085-
Etag : W/&quot;xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&quot;
46086-
ResourceGuid : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
46087-
ProvisioningState : Succeeded
46088-
Tags :
46089-
FrontendIpConfigurations : []
46090-
BackendAddressPools : []
46091-
LoadBalancingRules : [
46092-
&quot;Name&quot;: &quot;NewRule&quot;,
46093-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/inbo
46094-
undNatRules/NewRule&quot;,
46095-
&quot;FrontendPort&quot;: 3350,
46096-
&quot;EnableFloatingIP&quot;: false,
46097-
&quot;FrontendIPConfiguration&quot;: {
46098-
&quot;Id&quot;: &quot;/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/loadBalancers/MyLoadBalancer/fr
46099-
ontendIPConfigurations/MyFrontEnd&quot;
46100-
},
46101-
&quot;BackendPort&quot;: 3350,
46102-
&quot;Protocol&quot;: &quot;Tcp&quot;
46103-
}
46104-
]
46105-
Probes : []
46106-
InboundNatRules : []</maml:para>
46012+
<maml:para></maml:para>
4610746013
</dev:remarks>
4610846014
<command:commandLines>
4610946015
<command:commandLine>

0 commit comments

Comments
 (0)