New-AzLoadBalancerProbeConfig

Creates a probe configuration for a load balancer.

Syntax

New-AzLoadBalancerProbeConfig
   -Name <String>
   [-Protocol <String>]
   -Port <Int32>
   -IntervalInSeconds <Int32>
   -ProbeCount <Int32>
   [-ProbeThreshold <Int32>]
   [-RequestPath <String>]
   [-NoHealthyBackendsBehavior <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzLoadBalancerProbeConfig cmdlet creates a probe configuration for an Azure load balancer.

Examples

Example 1: Create a probe configuration

New-AzLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 15 -ProbeThreshold 15 -NoHealthyBackendsBehavior "AllProbedUp"

This command creates a probe configuration named MyProbe using the HTTP protocol. The new probe will connect to a load-balanced service on port 80.

Example 2

Creates a probe configuration for a load balancer. (autogenerated)

New-AzLoadBalancerProbeConfig -IntervalInSeconds 15 -Name 'MyProbe' -Port 80 -ProbeCount 15 -ProbeThreshold 15 -Protocol 'http' -RequestPath 'healthcheck.aspx'

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 a load-balanced service.

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

-Name

Specifies the name of the probe configuration to create.

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
Accepted values:AllProbedDown, AllProbedUp
Position:Named
Default value:AllProbedDown
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Port

Specifies the port on which the new probe 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 configuration. 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 a 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

String

Int32

Outputs

PSProbe