Set-AzureRmLoadBalancerFrontendIpConfig
Sets the goal state for a front-end IP configuration in 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
Set-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-PrivateIpAddress <String>]
[-Zone <System.Collections.Generic.List`1[System.String]>]
-Subnet <PSSubnet>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-PrivateIpAddress <String>]
[-Zone <System.Collections.Generic.List`1[System.String]>]
-SubnetId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <System.Collections.Generic.List`1[System.String]>]
-PublicIpAddressId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmLoadBalancerFrontendIpConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Zone <System.Collections.Generic.List`1[System.String]>]
-PublicIpAddress <PSPublicIpAddress>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzureRmLoadBalancerFrontendIpConfig cmdlet sets the goal state for a front-end IP configuration in an Azure load balancer.
Examples
Example 1: Modify the front-end IP configuration of a load balancer
PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyResourceGroup" | Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet"
PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup"
PS C:\> $slb | Add-AzureRmLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet
PS C:\> $slb | Set-AzureRmLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet
The 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-AzureRmLoadBalancerFrontendIpConfig, which creates a front-end IP configuration named NewFrontend for $slb. The fourth command passes the load balancer in $slb to Set-AzureRmLoadBalancerFrontendIpConfig, which saves and updates the front-end IP configuration.
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 load balancer. This cmdlet sets the goal state for 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 |
-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 |
-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: | 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]]