Skip to content

Latest commit

 

History

History
252 lines (198 loc) · 5.19 KB

New-AzFrontDoorBackendObject.md

File metadata and controls

252 lines (198 loc) · 5.19 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.dll-Help.xml
Az.FrontDoor
2.0.0

New-AzFrontDoorBackendObject

SYNOPSIS

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: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-EnabledState

Whether to enable use of this backend. Default value is Enabled

Type: Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState
Parameter Sets: (All)
Aliases:
Accepted values: Enabled, Disabled

Required: False
Position: Named
Default value: None
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: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:

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

-PrivateLinkLocation

The Location of Private Link resource. Location is required when PrivateLinkResourceId is set

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.Int32
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

None

OUTPUTS

Microsoft.Azure.Commands.FrontDoor.Models.PSBackend

NOTES

RELATED LINKS

New-AzFrontDoorBackendPoolObject