New-AzFrontDoorBackendObject
Create a PSBackend object
Syntax
Default (Default)
New-AzFrontDoorBackendObject
-Address <String>
[-HttpPort <Int32>]
[-HttpsPort <Int32>]
[-Priority <Int32>]
[-Weight <Int32>]
[-EnabledState <PSEnabledState>]
[-BackendHostHeader <String>]
[-PrivateLinkAlias <String>]
[-PrivateLinkResourceId <String>]
[-PrivateLinkLocation <String>]
[-PrivateLinkApprovalMessage <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Create a PSBackend object for Front Door creation
Examples
Example 1
New-AzFrontDoorBackendObject -Address "contoso1.azurewebsites.net"
Address : contoso1.azurewebsites.net
HttpPort : 80
HttpsPort : 443
Priority : 1
Weight : 50
BackendHostHeader :
EnabledState : Enabled
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: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The value to use as the host header sent to the backend.
Default value is the backend address.
Type: String
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
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.
Default value is Enabled
Parameter properties
Type: PSEnabledState
Default value: None Accepted values: Enabled, Disabled 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.
Default value is 80.
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.
Default value is 443
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.
Must be between 1 and 5.
Default value is 1
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 Private Link resource. Location is required when PrivateLinkResourceId is set
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. 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.
Must be between 1 and 1000.
Default value is 50
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 .
None
Outputs
