New-AzFrontDoorBackendObject
Create a PSBackend object
Syntax
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)
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackendHostHeader
The value to use as the host header sent to the backend. Default value is the backend address.
Type: | String |
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 |
-EnabledState
Whether to enable use of this backend. Default value is Enabled
Type: | PSEnabledState |
Accepted values: | Enabled, Disabled |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HttpPort
The HTTP TCP port number. Must be between 1 and 65535. Default value is 80.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HttpsPort
The HTTPS TCP port number. Must be between 1 and 65535. Default value is 443
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Priority
Priority to use for load balancing. Must be between 1 and 5. Default value is 1
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivateLinkAlias
The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivateLinkApprovalMessage
A custom message to be included in the approval request to connect to the Private Link
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivateLinkLocation
The Location of Private Link resource. Location is required when PrivateLinkResourceId is set
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivateLinkResourceId
The Resource ID of the Private Link. Populating this optional field indicates that this backend is 'Private'
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Weight
Weight of this endpoint for load balancing purposes. Must be between 1 and 1000. Default value is 50
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None