Set-AzApplicationGatewayRoutingRule
Modifies a routing rule for an application gateway.
Syntax
Set-AzApplicationGatewayRoutingRule
-ApplicationGateway <PSApplicationGateway>
-Name <String>
-RuleType <String>
-Priority <Int32>
[-BackendSettings <PSApplicationGatewayBackendSettings>]
[-Listener <PSApplicationGatewayListener>]
[-BackendAddressPool <PSApplicationGatewayBackendAddressPool>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzApplicationGatewayRoutingRule
-ApplicationGateway <PSApplicationGateway>
-Name <String>
-RuleType <String>
-Priority <Int32>
[-BackendSettingsId <String>]
[-ListenerId <String>]
[-BackendAddressPoolId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Set-AzApplicationGatewayRoutingRule cmdlet modifies a routing rule.
Examples
Example 1: Update a routing rule
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$AppGw = Set-AzApplicationGatewayRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -Priority 100 -BackendSettings $Setting -Listener $Listener -BackendAddressPool $Pool
The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. The second command modifies the routing rule for the application gateway to use back-end settings specified in the $Setting variable, a listener specified in the $Listener variable, and a back-end address pool specified in the $Pool variable.
Parameters
-ApplicationGateway
The applicationGateway
Type: | PSApplicationGateway |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-BackendAddressPool
Application gateway BackendAddressPool
Type: | PSApplicationGatewayBackendAddressPool |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackendAddressPoolId
ID of the application gateway BackendAddressPool
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackendSettings
Application gateway BackendSettings
Type: | PSApplicationGatewayBackendSettings |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackendSettingsId
ID of the application gateway BackendSettings
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 |
-Listener
Application gateway Listener
Type: | PSApplicationGatewayListener |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ListenerId
ID of the application gateway Listener
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the Routing Rule
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Priority
The priority of the rule
Type: | Nullable<T>[Int32] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RuleType
The type of rule
Type: | String |
Accepted values: | Basic, PathBasedRouting |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |