New-AzureRmApplicationGatewayHttpListener

Creates an HTTP listener for an application gateway.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmApplicationGatewayHttpListener
   -Name <String>
   [-FrontendIPConfigurationId <String>]
   [-FrontendPortId <String>]
   [-SslCertificateId <String>]
   [-HostName <String>]
   [-RequireServerNameIndication <String>]
   -Protocol <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
New-AzureRmApplicationGatewayHttpListener
   -Name <String>
   [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>]
   [-FrontendPort <PSApplicationGatewayFrontendPort>]
   [-SslCertificate <PSApplicationGatewaySslCertificate>]
   [-HostName <String>]
   [-RequireServerNameIndication <String>]
   -Protocol <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzureRmApplicationGatewayHttpListener cmdlet creates an HTTP listener for an Azure application gateway.

Examples

Example 1: Create an HTTP listener

PS C:\>$Listener = New-AzureRmApplicationGatewayHttpListener -Name "Listener01" -Protocol "Http" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01

This command creates an HTTP listener named Listener01 and stores the result in the variable named $Listener.

Example 2: Create an HTTP listener with SSL

PS C:\>$Listener = New-AzureRmApplicationGatewayHttpListener -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -SslCertificate $SSLCert01

This command creates an HTTP listener that uses SSL offload and provides the SSL certificate in the $SSLCert01 variable. The command stores the result in the variable named $Listener.

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FrontendIPConfiguration

Specifies front-end IP configuration object for the HTTP listener.

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

-FrontendIPConfigurationId

Specifies the ID of the front-end IP configuration for the HTTP listener.

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

-FrontendPort

Specifies the front-end port for the HTTP listener.

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

-FrontendPortId

Specifies the ID of the front-end port object for the HTTP listener.

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

-HostName

Specifies the host name of the application gateway HTTP listener.

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

-Name

Specifies the name of the HTTP listener that this cmdlet creates.

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

-Protocol

Specifies the protocol that the HTTP listener uses.

Type:String
Accepted values:Http, Https
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RequireServerNameIndication

Type:String
Accepted values:true, false
Position:Named
Default value:true
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SslCertificate

Specifies the SSL certificate object for the HTTP listener.

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

-SslCertificateId

Specifies the ID of the SSL certificate for the HTTP listener.

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

Inputs

None

Outputs

PSApplicationGatewayHttpListener