Add-AzLoadBalancerProbeConfig
Adds a probe configuration to a load balancer.
Syntax
Add-AzLoadBalancerProbeConfig
-LoadBalancer <PSLoadBalancer>
-Name <String>
[-Protocol <String>]
-Port <Int32>
-IntervalInSeconds <Int32>
-ProbeCount <Int32>
[-ProbeThreshold <Int32>]
[-RequestPath <String>]
[-NoHealthyBackendsBehavior <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Add-AzLoadBalancerProbeConfig cmdlet adds a probe configuration to an Azure load balancer.
Examples
Example 1: Add a probe configuration to a load balancer
Get-AzLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 -ProbeThreshold 3 -NoHealthyBackendsBehavior "AllProbedUp" | Set-AzLoadBalancerThis command gets the load balancer named myLb, adds the specified probe configuration to it, and then uses the Set-AzLoadBalancer 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: | AzContext, 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 |
-NoHealthyBackendsBehavior
Determines how new connections are handled by the load balancer when all backend instances are probed down. The acceptable values for this parameter are: AllProbedDown or AllProbedUp.
| Type: | String |
| Position: | Named |
| Default value: | AllProbedDown |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
-ProbeThreshold
Specifies the number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint.
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
