Edit

Add-AzApplicationGatewayUrlPathMapConfig

  • Reference
Module:
Az.Network

Adds an array of URL path mappings to a backend server pool.

Syntax

Add-AzApplicationGatewayUrlPathMapConfig
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -PathRules <PSApplicationGatewayPathRule[]>
   -DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>
   -DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>
   [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Add-AzApplicationGatewayUrlPathMapConfig
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -PathRules <PSApplicationGatewayPathRule[]>
   -DefaultBackendAddressPoolId <String>
   -DefaultBackendHttpSettingsId <String>
   [-DefaultRewriteRuleSetId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Add-AzApplicationGatewayUrlPathMapConfig
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -PathRules <PSApplicationGatewayPathRule[]>
   [-DefaultRewriteRuleSet <PSApplicationGatewayRewriteRuleSet>]
   -DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Add-AzApplicationGatewayUrlPathMapConfig
   -ApplicationGateway <PSApplicationGateway>
   -Name <String>
   -PathRules <PSApplicationGatewayPathRule[]>
   [-DefaultRewriteRuleSetId <String>]
   -DefaultRedirectConfigurationId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Add-AzApplicationGatewayUrlPathMapConfig cmdlet adds an array of URL path mappings to a back end server pool.

Examples

Example 1: Add an URL path mapping to an application gateway.

$appgw = Get-AzApplicationGateway -ResourceGroupName "rg" -Name "appGwName"
$pool = Get-AzApplicationGatewayBackendAddressPool -ApplicationGateway $appgw -Name "pool01"
$poolSettings = Get-AzApplicationGatewayBackendHttpSetting -ApplicationGateway $appgw -Name "poolSettings01"
$pathRule = New-AzApplicationGatewayPathRuleConfig -Name "rule01" -Paths "/path" -BackendAddressPool $pool -BackendHttpSettings $poolSettings
$appgw = Add-AzApplicationGatewayUrlPathMapConfig -ApplicationGateway $appgw -Name "url01" -PathRules $pathRule -DefaultBackendAddressPool $pool -DefaultBackendHttpSettings $poolSettings
$appgw = Set-AzApplicationGateway -ApplicationGateway $appgw

The first command gets an application gateway named appGwName and stores it in $appgw variable. The second command gets backend address pool and stores it in $pool variable. The third command gets backend http settings and stores it in $poolSettings variable. The fourth command create new path rule configuration named rule01 and stores it in $pathRule variable. The fifth command adds url path mapping configuration named url01 to the application gateway. The sixth command updates the application gateway.

Parameters

-ApplicationGateway

Specifies the application gateway to which this cmdlet adds a URL path map configuration.

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

-DefaultBackendAddressPool

Specifies the default backend address pool to route in case none of the rules specified in the pathRules parameter match.

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

-DefaultBackendAddressPoolId

Specifies the default backend address pool ID.

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

-DefaultBackendHttpSettings

Specifies the default backend HTTP settings to use in case none of the rules specified in the pathRules parameter match.

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

-DefaultBackendHttpSettingsId

Specifies the default backend HTTP settings ID.

Type:String
Position:Named
Default value:None
Required:True
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

-DefaultRedirectConfiguration

Application gateway default RedirectConfiguration

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

-DefaultRedirectConfigurationId

ID of the application gateway default RedirectConfiguration

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

-DefaultRewriteRuleSet

Application gateway default rewrite rule set

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

-DefaultRewriteRuleSetId

ID of the application gateway default rewrite rule set

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

-Name

Specifies the URL path map name that this cmdlet adds to the backend server pool.

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

-PathRules

Specifies a list of path rules. The path rules are order sensitive, they are applied in order they are specified.

Type:PSApplicationGatewayPathRule[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSApplicationGateway

Outputs

PSApplicationGateway