Add-AzureRmLoadBalancerFrontendIpConfig
Adds a front-end IP configuration to a load balancer.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Add-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-PrivateIpAddress <String>]
[-Zone <System.Collections.Generic.List`1[System.String]>]
-Subnet <PSSubnet>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-PrivateIpAddress <String>]
[-Zone <System.Collections.Generic.List`1[System.String]>]
-SubnetId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <System.Collections.Generic.List`1[System.String]>]
-PublicIpAddressId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <System.Collections.Generic.List`1[System.String]>]
-PublicIpAddress <PSPublicIpAddress>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Add-AzureRmLoadBalancerFrontendIpConifg cmdlet adds a front-end IP configuration to an Azure load balancer.
Examples
Example 1 Add a front-end IP configuration with a dynamic IP address
PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyRg" | Get-AzureRmVirtualNetworkSubnetConfig -Name "MySubnet"
PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet | Set-AzureRmLoadBalancer
The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the Get-AzureRmVirtualNetworkSubnetConfig cmdlet to get the subnet named MySubnet. The command then stores the result in the variable named $Subnet. The second command gets the load balancer named MyLB and passes the result to the Add-AzureRmLoadBalancerFrontendIpConfig cmdlet that adds a front-end IP configuration to the load balancer with a dynamic private IP address from the subnet stored in the variable named $MySubnet.
Example 2 Add a front-end IP configuration with a static IP address
PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "RG001" | Get-AzureRmVirtualNetworkSubnetConfig -Name "MySubnet"
PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet -PrivateIpAddress "10.0.1.6" | Set-AzureRmLoadBalancer
The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the Get-AzureRmVirtualNetworkSubnetConfig cmdlet to get the subnet named MySubnet. The command then stores the result in the variable named $Subnet. The second command gets the load balancer named MyLB and passes the result to the Add-AzureRmLoadBalancerFrontendIpConfig cmdlet that adds a front-end IP configuration to the load balancer with a static private IP address from the subnet stored in the variable named $Subnet.
Example 3 Add a front-end IP configuration with a public IP address
PS C:\>$PublicIp = Get-AzureRmPublicIpAddress -ResourceGroupName "myRG" -Name "MyPub"
PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -PublicIpAddress $PublicIp | Set-AzureRmLoadBalancer
The first command gets the Azure public IP address named MyPub and stores the result in the variable named $PublicIp. The second command gets the load balancer named MyLB and passes the result to the Add-AzureRmLoadBalancerFrontendIpConfig cmdlet that adds a front-end IP configuration to the load balancer with public IP address stored in the variable named $PublicIp.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LoadBalancer
Specifies a LoadBalancer object. This cmdlet adds a front-end IP configuration to the load balancer that this parameter specifies.
Type: | PSLoadBalancer |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of the front-end IP configuration to add.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivateIpAddress
Specifies the private IP address to associate with a front-end IP configuration.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PublicIpAddress
Specifies the public IP address to associate with a front-end IP configuration.
Type: | PSPublicIpAddress |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PublicIpAddressId
Specifes the ID of the public IP address in which to add a front-end IP configuration.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Subnet
Specifies the subnet object in which to add a front-end IP configuration.
Type: | PSSubnet |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubnetId
Specifies the ID of the subnet in which to add a front-end IP configuration.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Zone
A list of availability zones denoting the IP allocated for the resource needs to come from.
Type: | List<T>[String] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Parameters: LoadBalancer (ByValue)
System.Collections.Generic.List\`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]