New-AzApplicationGatewayBackendSetting
Creates back-end TCP\TLS setting for an application gateway.
Syntax
New-AzApplicationGatewayBackendSetting
-Name <String>
-Port <Int32>
-Protocol <String>
[-Timeout <Int32>]
[-ProbeId <String>]
[-Probe <PSApplicationGatewayProbe>]
[-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
[-PickHostNameFromBackendAddress]
[-HostName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The New-AzApplicationGatewayBackendSetting cmdlet creates back-end TCP\TLS settings for an application gateway. Back-end settings are applied to all back-end servers in a pool.
Examples
Example 1: Create back-end TCP\TLS settings
$Setting = New-AzApplicationGatewayBackendSetting -Name "Setting01" -Port 80 -Protocol Tcp
This command creates back-end settings named Setting01 on port 80, using the Tcp protocol The settings are stored in the $Setting variable.
Parameters
-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 |
-HostName
Sets host header to be sent to the backend servers.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the backend settings
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PickHostNameFromBackendAddress
Flag if host header should be picked from the host name of the backend server.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Port
Port
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Probe
Application gateway Probe
Type: | PSApplicationGatewayProbe |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProbeId
ID of the application gateway Probe
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Protocol
Protocol
Type: | String |
Accepted values: | TCP, TLS |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Timeout
Timeout. Default value 30 seconds.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrustedRootCertificate
Application gateway Trusted Root Certificates
Type: | PSApplicationGatewayTrustedRootCertificate[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
PSApplicationGatewayBackendSettings
Related Links
Azure PowerShell