Edit

Share via

New-AzFrontDoorBackendObject

Module:
Az.FrontDoor Module

Create an in-memory object for Backend.

Syntax

Default (Default) 

New-AzFrontDoorBackendObject
    [-Address <String>]
    [-BackendHostHeader <String>]
    [-EnabledState <String>]
    [-HttpPort <Int32>]
    [-HttpsPort <Int32>]
    [-Priority <Int32>]
    [-PrivateLinkAlias <String>]
    [-PrivateLinkApprovalMessage <String>]
    [-PrivateLinkLocation <String>]
    [-PrivateLinkResourceId <String>]
    [-Weight <Int32>]
    [<CommonParameters>]

Description

Create an in-memory object for Backend.

Examples

Example 1

New-AzFrontDoorBackendObject -Address "contoso1.azurewebsites.net"

Address                    : contoso1.azurewebsites.net
BackendHostHeader          : contoso1.azurewebsites.net
EnabledState               : Enabled
HttpPort                   : 80
HttpsPort                  : 443
Priority                   : 1
PrivateEndpointStatus      :
PrivateLinkAlias           :
PrivateLinkApprovalMessage :
PrivateLinkLocation        :
PrivateLinkResourceId      :
Weight                     : 50

Create a PSBackend object for Front Door creation

Parameters

-Address

Location of the backend (IP address or FQDN).

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

-BackendHostHeader

The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.

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

-EnabledState

Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'.

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

-HttpPort

The HTTP TCP port number. Must be between 1 and 65535.

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

-HttpsPort

The HTTPS TCP port number. Must be between 1 and 65535.

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

-Priority

Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.

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

-PrivateLinkAlias

The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

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

-PrivateLinkApprovalMessage

A custom message to be included in the approval request to connect to the Private Link.

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

-PrivateLinkLocation

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.

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

-PrivateLinkResourceId

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

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

-Weight

Weight of this endpoint for load balancing purposes.

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

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

Backend