Add-AzureRmLoadBalancerProbeConfig

  • Reference
Module:
AzureRM.Network

Adds a probe 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-AzureRmLoadBalancerProbeConfig
   -LoadBalancer <PSLoadBalancer>
   -Name <String>
   [-Protocol <String>]
   -Port <Int32>
   -IntervalInSeconds <Int32>
   -ProbeCount <Int32>
   [-RequestPath <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-AzureRmLoadBalancerProbeConfig cmdlet adds a probe configuration to an Azure load balancer.

Examples

Example 1 Add a probe configuration to a load balancer

PS C:\>Get-AzureRmLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzureRmLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 | Set-AzureRmLoadBalancer

This command gets the load balancer named myLb, adds the specified probe configuration to it, and then uses the Set-AzureRmLoadBalancer cmdlet to update the load balancer.

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

-IntervalInSeconds

Specifies the interval, in seconds, between probes to each instance of the load-balanced service.

Type:Int32
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LoadBalancer

Specifies a LoadBalancer object. This cmdlet adds a probe 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 probe configuration to add.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Port

Specifies the port on which probes should connect to a load-balanced service.

Type:Int32
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProbeCount

Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy.

Type:Int32
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Protocol

Specifies the protocol to use for the probe. The acceptable values for this parameter are: Tcp or Http.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RequestPath

Specifies the path in the load-balanced service to probe to determine health.

Type:String
Position:Named
Default value:None
Required:False
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

Inputs

PSLoadBalancer

Parameters: LoadBalancer (ByValue)

Outputs

PSLoadBalancer