Set-AzLoadBalancerFrontendIpConfig
Updates a front-end IP configuration for a load balancer.
Syntax
Set-AzLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-PrivateIpAddress <String>]
[-PrivateIpAddressVersion <String>]
[-Zone <String[]>]
-Subnet <PSSubnet>
[-GatewayLoadBalancerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-PrivateIpAddress <String>]
[-PrivateIpAddressVersion <String>]
[-Zone <String[]>]
-SubnetId <String>
[-GatewayLoadBalancerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <String[]>]
-PublicIpAddressId <String>
[-GatewayLoadBalancerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <String[]>]
-PublicIpAddress <PSPublicIpAddress>
[-GatewayLoadBalancerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <String[]>]
-PublicIpAddressPrefixId <String>
[-GatewayLoadBalancerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <String[]>]
-PublicIpAddressPrefix <PSPublicIpPrefix>
[-GatewayLoadBalancerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzLoadBalancerFrontendIpConfig cmdlet updates a front-end IP configuration for a load balancer.
Examples
Example 1: Modify the front-end IP configuration of a load balancer
$Subnet = Get-AzVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyResourceGroup" | Get-AzVirtualNetworkSubnetConfig -Name "Subnet"
$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup"
$slb | Add-AzLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet
$slb | Set-AzLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet
$slb | Set-AzLoadBalancerThe first command gets the virtual subnet named Subnet, and then stores it in the $Subnet variable. The second command gets the associated load balancer named MyLoadBalancer, and then stores it in the $slb variable. The third command uses the pipeline operator to pass the load balancer in $slb to Add-AzLoadBalancerFrontendIpConfig, which creates a front-end IP configuration named NewFrontend for $slb. The fourth command passes the load balancer in $slb to Set-AzLoadBalancerFrontendIpConfig, which saves and updates the front-end IP configuration.
Example 2: Modify the front-end IP configuration of a load balancer with Gateway Load Balancer
$slb1 = Get-AzLoadBalancer -Name "MyLoadBalancer1" -ResourceGroupName "MyResourceGroup"
$feip = Get-AzLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -LoadBalancer $slb1
$slb2 = Get-AzLoadBalancer -Name "MyLoadBalancer1" -ResourceGroupName "MyResourceGroup"
$slb2 | Set-AzLoadBalancerFrontendIpConfig -Name "NewFrontend" -PublicIpAddress $publicIp -GatewayLoadBalancerId $feip.Id
$slb2 | Set-AzLoadBalancerParameters
-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: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GatewayLoadBalancerId
Specifies the ID of the Gateway Load Balancer Provider Frontend Ip Configuration.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoadBalancer
Specifies a load balancer. This cmdlet updates a front-end configuration for 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 set.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateIpAddress
Specifies the private IP address of the load balancer that is associated with the front-end IP configuration to set. Specify this parameter only if you also specify the Subnet parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PrivateIpAddressVersion
The private IP address version of the IP configuration.
| Type: | String |
| Accepted values: | IPv4, IPv6 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PublicIpAddress
Specifies the PublicIpAddress object that is associated with the front-end IP configuration to set.
| Type: | PSPublicIpAddress |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PublicIpAddressId
Specifies the ID of the PublicIpAddress object that is associated with the front-end IP configuration that this cmdlet sets.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PublicIpAddressPrefix
Specifies the PublicIpAddressPrefix object to associate with a front-end IP configuration.
| Type: | PSPublicIpPrefix |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PublicIpAddressPrefixId
Specifies the ID of the PublicIpAddressPrefix object to associate with 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 that contains the front-end IP configuration that this cmdlet sets.
| Type: | PSSubnet |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubnetId
Specifies the ID of the subnet that contains the front-end IP configuration that this cmdlet sets.
| 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: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
String[]
Outputs
Related Links
Azure PowerShell