Edit

Share via


New-AzFrontDoorForwardingConfigurationObject

Create an in-memory object for ForwardingConfiguration.

Syntax

Default (Default)

New-AzFrontDoorForwardingConfigurationObject
    [-BackendPoolId <String>]
    [-CacheConfiguration <ICacheConfiguration>]
    [-CustomForwardingPath <String>]
    [-ForwardingProtocol <String>]
    [<CommonParameters>]

Description

Create an in-memory object for ForwardingConfiguration.

Examples

Example 1: Create a basic forwarding configuration object

New-AzFrontDoorForwardingConfigurationObject -BackendPoolId "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/frontDoors/myFrontDoor/backendPools/myBackendPool" -ForwardingProtocol "MatchRequest"
BackendPoolId        : /subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/frontDoors/myFrontDoor/backendPools/myBackendPool
CacheConfiguration   : {
                       }
CustomForwardingPath :
ForwardingProtocol   : MatchRequest
OdataType            : #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration

Create a basic forwarding configuration object that forwards requests to a backend pool using the same protocol as the incoming request.

Example 2: Create a forwarding configuration object with cache and custom path

$cacheConfig = New-AzFrontDoorCacheConfigurationObject -CacheDuration "0.12:00:00" -DynamicCompression "Enabled"
New-AzFrontDoorForwardingConfigurationObject -BackendPoolId "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/frontDoors/myFrontDoor/backendPools/myBackendPool" -ForwardingProtocol "HttpsOnly" -CustomForwardingPath "/api/v2" -CacheConfiguration $cacheConfig
BackendPoolId        : /subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/frontDoors/myFrontDoor/backendPools/myBackendPool
CacheConfiguration   : {
                       }
CustomForwardingPath : /api/v2
ForwardingProtocol   : HttpsOnly
OdataType            : #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration

Create a forwarding configuration object with caching enabled, custom forwarding path, and HTTPS-only forwarding protocol.

Parameters

-BackendPoolId

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

-CacheConfiguration

The caching configuration associated with this rule.

Parameter properties

Type:ICacheConfiguration
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

-CustomForwardingPath

A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.

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

-ForwardingProtocol

Protocol this rule will use when forwarding traffic to backends.

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

ForwardingConfiguration