Edit

Share via

New-AzFrontDoorHealthProbeSettingObject

Module:
Az.FrontDoor Module

Create an in-memory object for HealthProbeSettingsModel.

Syntax

Default (Default) 

New-AzFrontDoorHealthProbeSettingObject
    [-EnabledState <String>]
    [-HealthProbeMethod <String>]
    [-IntervalInSeconds <Int32>]
    [-Name <String>]
    [-Path <String>]
    [-Protocol <String>]
    [-Id <String>]
    [<CommonParameters>]

Description

Create an in-memory object for HealthProbeSettingsModel.

Examples

Example 1: Create a PSHealthProbeSetting object for Front Door creation

New-AzFrontDoorHealthProbeSettingObject -Name "healthProbeSetting1"

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

Note: HealthProbeMethod setting is not case sensitive.

Create a PSHealthProbeSetting object for Front Door creation

Parameters

-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HealthProbeMethod

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Resource ID.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IntervalInSeconds

The number of seconds between health probes.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Path

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Protocol

Protocol scheme to use for this probe.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

HealthProbeSettingsModel