Edit

Share via

New-AzApplicationGatewayRewriteRuleHeaderConfiguration

Module:
Az.Network Module

Creates a rewrite rule header configuration for an application gateway.

Syntax

Default (Default) 

New-AzApplicationGatewayRewriteRuleHeaderConfiguration
    -HeaderName <String>
    [-HeaderValue <String>]
    [-HeaderValueMatcher <PSApplicationGatewayHeaderValueMatcher>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The AzApplicationGatewayRewriteRuleHeaderConfiguration cmdlet creates a rewrite rule action set for an Azure application gateway.

Examples

Example 1

$hc = New-AzApplicationGatewayRewriteRuleHeaderConfiguration -HeaderName abc -HeaderValue def

This command creates a rewrite rule header configuration and stores the result in the variable named $hc.

Parameters

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HeaderName

Name of the Header to rewrite

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HeaderValue

Header value to the set for the given header name. Header will be deleted if this is omitted

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

-HeaderValueMatcher

An optional field under 'Rewrite Action'. It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud

Parameter properties

Type:PSApplicationGatewayHeaderValueMatcher
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.

Inputs

None

Outputs

PSApplicationGatewayHeaderConfiguration