New-AzFrontDoorHealthProbeSettingObject

  • Reference
Module:
Az.FrontDoor

Create a PSHealthProbeSetting object for Front Door creation

Syntax

New-AzFrontDoorHealthProbeSettingObject
   -Name <String>
   [-Path <String>]
   [-Protocol <PSProtocol>]
   [-IntervalInSeconds <Int32>]
   [-HealthProbeMethod <String>]
   [-EnabledState <PSEnabledState>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Create a PSHealthProbeSetting object for Front Door creation

Examples

Example 1

New-AzFrontDoorHealthProbeSettingObject -Name "healthProbeSetting1"

Path              : /
Protocol          : Http
IntervalInSeconds : 30
ResourceState     :
HealthProbeMethod : Head
EnabledState      : Enabled
Id                :
Name              : healthProbeSetting1
Type              :

Note: HealthProbeMethod setting is not case sensitive.

Create a PSHealthProbeSetting object for Front Door creation

Parameters

-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

-EnabledState

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.

Type:PSEnabledState
Accepted values:Enabled, Disabled
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HealthProbeMethod

Configures which HTTP method to use to probe the backends defined under backendPools.

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

-IntervalInSeconds

The number of seconds between health probes. Default value is 30

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

-Name

Health probe setting name.

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

-Path

The path to use for the health probe. Default is /

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

-Protocol

Protocol scheme to use for this probe Default value is HTTP

Type:PSProtocol
Accepted values:Http, Https
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

PSHealthProbeSetting