Add-AzureLoadBalancerProbeConfig
Add-AzureLoadBalancerProbeConfig
Adds a probe configuration to a load balancer.
Syntax
Parameter Set: Default
Add-AzureLoadBalancerProbeConfig -IntervalInSeconds <Int32> -LoadBalancer <PSLoadBalancer> -Name <String> -Port <Int32> -ProbeCount <Int32> -RequestPath <String> [-Profile <AzureProfile> ] [-Protocol <String> {Tcp | Http} ] [ <CommonParameters>]
Detailed Description
The Add-AzureLoadBalancerProbeConfig cmdlet adds a probe configuration to an Azure load balancer.
Parameters
-IntervalInSeconds<Int32>
Specifies the interval, in seconds, between probes to each instance of the load-balanced service.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancer<PSLoadBalancer>
Specifies a LoadBalancer object. This cmdlet adds a probe configuration to the load balancer that this parameter specifies.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByValue) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the probe configuration to add.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Port<Int32>
Specifies the port on which probes should connect to a load-balanced service.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProbeCount<Int32>
Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Profile<AzureProfile>
Specifies an Azure profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Protocol<String>
Specifies the protocol to use for the probe. The acceptable values for this parameter are:Tcp or Http.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RequestPath<String>
Specifies the path in the load-balanced service to probe to determine health.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1 Add a probe configuration to a load balancer
This command gets the load balancer named myLb, adds the specified probe configuration to it, and then uses the Set-AzureLoadBalancer cmdlet to update the load balancer.
PS C:\> Get-AzureLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzureLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 | Set-AzureLoadBalancer
Related topics
Get-AzureLoadBalancerProbeConfig
New-AzureLoadBalancerProbeConfig