Edit

New-AzApplicationGatewayClientAuthConfiguration

Creates a new client authentication configuration for SSL profile.

Syntax

Default (Default)

New-AzApplicationGatewayClientAuthConfiguration
    [-VerifyClientCertIssuerDN]
    [-VerifyClientRevocation <String>]
    [-VerifyClientAuthMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

Description

The New-AzApplicationGatewayClientAuthConfiguration cmdlet creates a new client authentication configuration for SSL profile.

Examples

Example 1

$clientAuthConfig = New-AzApplicationGatewayClientAuthConfiguration -VerifyClientCertIssuerDN -VerifyClientRevocation OCSP

The command create a new client auth configuration and stores it in $clientAuthConfig variable to be used in a SSL profile.

Example 2: Create a client auth configuration for mutual TLS (mTLS) passthrough

$clientAuthConfig = New-AzApplicationGatewayClientAuthConfiguration -VerifyClientAuthMode Passthrough

The command creates a new client auth configuration in Passthrough mode. The application gateway requests the client certificate and forwards it to the backend without verifying it, leaving client certificate authentication to the backend.

Parameters

-AcquirePolicyToken

Acquire an Azure Policy token automatically for this resource operation.

Parameter properties

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

-ChangeReference

The change reference resource ID for this resource operation.

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

-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

-VerifyClientAuthMode

Client certificate verification mode. In Passthrough mode the application gateway forwards the client certificate to the backend without verifying it.

Parameter properties

Type:String
Default value:None
Accepted values:Strict, Passthrough
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

-VerifyClientCertIssuerDN

Verify client certificate issuer name.

Parameter properties

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

-VerifyClientRevocation

Verify client certificate revocation status.

Parameter properties

Type:String
Default value:None
Accepted values:None, OCSP
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

PSApplicationGatewayClientAuthConfiguration