< Back
New-AzureRmApplicationGatewayPathRuleConfig
Post
NAME New-AzureRmApplicationGatewayPathRuleConfig
SYNOPSIS
Creates an application gateway path rule.
SYNTAX
New-AzureRmApplicationGatewayPathRuleConfig [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-BackendHttpSettings
<PSApplicationGatewayBackendHttpSettings>] [-DefaultProfile <IAzureContextContainer>] -Name <String> -Paths
<System.Collections.Generic.List`1[System.String]> [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] [<CommonParameters>]
New-AzureRmApplicationGatewayPathRuleConfig [-BackendAddressPoolId <String>] [-BackendHttpSettingsId <String>] [-DefaultProfile
<IAzureContextContainer>] -Name <String> -Paths <System.Collections.Generic.List`1[System.String]> [-RedirectConfigurationId <String>]
[<CommonParameters>]
DESCRIPTION
The New-AzureRmApplicationGatewayPathRuleConfig cmdlet creates an application gateway path rule. Rules created by this cmdlet can be added to a
collection of URL path map configuration settings and then assigned to a gateway.
Path map configuration settings are used in application gateway load balancing.
PARAMETERS
-BackendAddressPool <PSApplicationGatewayBackendAddressPool>
Specifies an object reference to a collection of backend address pool settings to be added to the gateway path rules configuration settings.
You can create this object reference by using the New-AzureRmApplicationGatewayBackendAddressPool cmdlet and syntax similar to this:
`$AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2"`
The preceding command adds two IP addresses (192.16.1.1 and 192.168.1.2) to the address pool. Note that the IP address are enclosed in quote
marks and separated by using commas.
The resulting variable, $AddressPool, can then be used as the parameter value for the DefaultBackendAddressPool parameter.
The backend address pool represents the IP addresses on the backend servers. These IP addresses should either belong to the virtual network
subnet or should be public IP addresses. If you use this parameter you cannot use the DefaultBackendAddressPoolId parameter in the same
command.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendAddressPoolId <String>
Specifies the ID of an existing backend address pool that can be added to the gateway path rule configuration settings. Address pool IDs can
be returned by using the Get-AzureRmApplicationGatewayBackendAddressPool cmdlet. After you have the ID you can then use the
DefaultBackendAddressPoolId parameter instead of the DefaultBackendAddressPool parameter. For instance:
-DefaultBackendAddressPoolId "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicati
onGateways/appgwtest/backendAddressPools/ContosoAddressPool"
The backend address pool represents the IP addresses on the backend servers. These IP addresses should either belong to the virtual network
subnet or should be public IP addresses.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>
Specifies an object reference to a collection of backend HTTP settings to be added to the gateway path rule configuration settings. You can
create this object reference by using the New-AzureRmApplicationGatewayBackendHttpSettings cmdlet and syntax similar to this:
$HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity
"Disabled"
The resulting variable, $HttpSettings, can then be used as the parameter value for the DefaultBackendAddressPool parameter:
-DefaultBackendHttpSettings $HttpSettings
The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. If you use this parameter
you cannot use the DefaultBackendHttpSettingsId parameter in the same command.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendHttpSettingsId <String>
Specifies the ID of an existing backend HTTP settings collection that can be added to the gateway path rule configuration settings. HTTP
setting IDs can be returned by using the Get-AzureRmApplicationGatewayBackendHttpSettings cmdlet. After you have the ID you can then use the
DefaultBackendHttpSettingsId parameter instead of the DefaultBackendHttpSettings parameter. For instance:
-DefaultBackendSettings Id "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/application
Gateways/appgwtest/backendHttpSettingsCollection/ContosoHttpSettings"
The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. If you use this parameter
you cannot use the DefaultBackendHttpSettings parameter in the same command.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the path rule configuration that this cmdlet creates.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Paths <System.Collections.Generic.List`1[System.String]>
Specifies one or more application gateway path rules.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>
Application gateway RedirectConfiguration
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RedirectConfigurationId <String>
ID of the application gateway RedirectConfiguration
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
New-AzureRmApplicationGatewayPathRuleConfig does not accept pipelined input.
OUTPUTS
New-AzureRmApplicationGatewayPathRuleConfig creates new instances of the Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule
object.
NOTES
Example 1
PS C:\\>$Gateway = Get-AzureRmApplicationGateway -Name "ContosoApplicationGateway"
PS C:\\> $AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2"
PS C:\\> $HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity
"Disabled"
PS C:\\> $PathRuleConfig = New-AzureRmApplicationGatewayPathRuleConfig -Name "base" -Paths "/base" -BackendAddressPool $AddressPool
-BackendHttpSettings $HttpSettings
PS C:\\> Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway $Gateway -Name "ContosoUrlPathMap" -PathRules $PathRuleConfig
-DefaultBackendAddressPool $AddressPool -DefaultBackendHttpSettings $HttpSettings
These commands create a new application gateway path rule and then use the Add-AzureRmApplicationGatewayUrlPathMapConfig cmdlet to assign that
rule to an application gateway. To do this, the first command creates an object reference to the gateway ContosoApplicationGateway. This object
reference is stored in a variable named $Gateway.
The next two commands create a backend address pool and a backend HTTP settings object; these objects (stored in the variables $AddressPool and
$HttpSettings) are needed in order to create a path rule object.
The fourth command creates the path rule object and is stored in a variable named $PathRuleConfig.
The fifth command uses Add-AzureRmApplicationGatewayUrlPathMapConfig to add the configuration settings and the new path rule contained within
those settings to ContosoApplicationGateway.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ruleconfig
Add-AzureRmApplicationGatewayUrlPathMapConfig
Get-AzureRmApplicationGatewayAvailableSslOptions
Get-AzureRmApplicationGatewayUrlPathMapConfig
New-AzureRmApplicationGatewayBackendAddressPool
New-AzureRmApplicationGatewayBackendHttpSettings
New-AzureRmApplicationGatewayPathRuleConfig
New-AzureRmApplicationGatewayUrlPathMapConfig
Remove-AzureRmApplicationGatewayUrlPathMapConfig
Set-AzureRmApplicationGatewayUrlPathMapConfig
SYNOPSIS
Creates an application gateway path rule.
SYNTAX
New-AzureRmApplicationGatewayPathRuleConfig [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-BackendHttpSettings
<PSApplicationGatewayBackendHttpSettings>] [-DefaultProfile <IAzureContextContainer>] -Name <String> -Paths
<System.Collections.Generic.List`1[System.String]> [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] [<CommonParameters>]
New-AzureRmApplicationGatewayPathRuleConfig [-BackendAddressPoolId <String>] [-BackendHttpSettingsId <String>] [-DefaultProfile
<IAzureContextContainer>] -Name <String> -Paths <System.Collections.Generic.List`1[System.String]> [-RedirectConfigurationId <String>]
[<CommonParameters>]
DESCRIPTION
The New-AzureRmApplicationGatewayPathRuleConfig cmdlet creates an application gateway path rule. Rules created by this cmdlet can be added to a
collection of URL path map configuration settings and then assigned to a gateway.
Path map configuration settings are used in application gateway load balancing.
PARAMETERS
-BackendAddressPool <PSApplicationGatewayBackendAddressPool>
Specifies an object reference to a collection of backend address pool settings to be added to the gateway path rules configuration settings.
You can create this object reference by using the New-AzureRmApplicationGatewayBackendAddressPool cmdlet and syntax similar to this:
`$AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2"`
The preceding command adds two IP addresses (192.16.1.1 and 192.168.1.2) to the address pool. Note that the IP address are enclosed in quote
marks and separated by using commas.
The resulting variable, $AddressPool, can then be used as the parameter value for the DefaultBackendAddressPool parameter.
The backend address pool represents the IP addresses on the backend servers. These IP addresses should either belong to the virtual network
subnet or should be public IP addresses. If you use this parameter you cannot use the DefaultBackendAddressPoolId parameter in the same
command.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendAddressPoolId <String>
Specifies the ID of an existing backend address pool that can be added to the gateway path rule configuration settings. Address pool IDs can
be returned by using the Get-AzureRmApplicationGatewayBackendAddressPool cmdlet. After you have the ID you can then use the
DefaultBackendAddressPoolId parameter instead of the DefaultBackendAddressPool parameter. For instance:
-DefaultBackendAddressPoolId "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicati
onGateways/appgwtest/backendAddressPools/ContosoAddressPool"
The backend address pool represents the IP addresses on the backend servers. These IP addresses should either belong to the virtual network
subnet or should be public IP addresses.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>
Specifies an object reference to a collection of backend HTTP settings to be added to the gateway path rule configuration settings. You can
create this object reference by using the New-AzureRmApplicationGatewayBackendHttpSettings cmdlet and syntax similar to this:
$HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity
"Disabled"
The resulting variable, $HttpSettings, can then be used as the parameter value for the DefaultBackendAddressPool parameter:
-DefaultBackendHttpSettings $HttpSettings
The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. If you use this parameter
you cannot use the DefaultBackendHttpSettingsId parameter in the same command.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendHttpSettingsId <String>
Specifies the ID of an existing backend HTTP settings collection that can be added to the gateway path rule configuration settings. HTTP
setting IDs can be returned by using the Get-AzureRmApplicationGatewayBackendHttpSettings cmdlet. After you have the ID you can then use the
DefaultBackendHttpSettingsId parameter instead of the DefaultBackendHttpSettings parameter. For instance:
-DefaultBackendSettings Id "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/application
Gateways/appgwtest/backendHttpSettingsCollection/ContosoHttpSettings"
The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. If you use this parameter
you cannot use the DefaultBackendHttpSettings parameter in the same command.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the path rule configuration that this cmdlet creates.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Paths <System.Collections.Generic.List`1[System.String]>
Specifies one or more application gateway path rules.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>
Application gateway RedirectConfiguration
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RedirectConfigurationId <String>
ID of the application gateway RedirectConfiguration
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
New-AzureRmApplicationGatewayPathRuleConfig does not accept pipelined input.
OUTPUTS
New-AzureRmApplicationGatewayPathRuleConfig creates new instances of the Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule
object.
NOTES
Example 1
PS C:\\>$Gateway = Get-AzureRmApplicationGateway -Name "ContosoApplicationGateway"
PS C:\\> $AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2"
PS C:\\> $HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity
"Disabled"
PS C:\\> $PathRuleConfig = New-AzureRmApplicationGatewayPathRuleConfig -Name "base" -Paths "/base" -BackendAddressPool $AddressPool
-BackendHttpSettings $HttpSettings
PS C:\\> Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway $Gateway -Name "ContosoUrlPathMap" -PathRules $PathRuleConfig
-DefaultBackendAddressPool $AddressPool -DefaultBackendHttpSettings $HttpSettings
These commands create a new application gateway path rule and then use the Add-AzureRmApplicationGatewayUrlPathMapConfig cmdlet to assign that
rule to an application gateway. To do this, the first command creates an object reference to the gateway ContosoApplicationGateway. This object
reference is stored in a variable named $Gateway.
The next two commands create a backend address pool and a backend HTTP settings object; these objects (stored in the variables $AddressPool and
$HttpSettings) are needed in order to create a path rule object.
The fourth command creates the path rule object and is stored in a variable named $PathRuleConfig.
The fifth command uses Add-AzureRmApplicationGatewayUrlPathMapConfig to add the configuration settings and the new path rule contained within
those settings to ContosoApplicationGateway.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ruleconfig
Add-AzureRmApplicationGatewayUrlPathMapConfig
Get-AzureRmApplicationGatewayAvailableSslOptions
Get-AzureRmApplicationGatewayUrlPathMapConfig
New-AzureRmApplicationGatewayBackendAddressPool
New-AzureRmApplicationGatewayBackendHttpSettings
New-AzureRmApplicationGatewayPathRuleConfig
New-AzureRmApplicationGatewayUrlPathMapConfig
Remove-AzureRmApplicationGatewayUrlPathMapConfig
Set-AzureRmApplicationGatewayUrlPathMapConfig