Share via


ApplicationGatewayBackendHttpSettings Class

Definition

Backend address pool settings of an application gateway.

public class ApplicationGatewayBackendHttpSettings : Azure.Provisioning.Primitives.ProvisionableConstruct
type ApplicationGatewayBackendHttpSettings = class
    inherit ProvisionableConstruct
Public Class ApplicationGatewayBackendHttpSettings
Inherits ProvisionableConstruct
Inheritance
ApplicationGatewayBackendHttpSettings

Constructors

Name Description
ApplicationGatewayBackendHttpSettings()

Creates a new ApplicationGatewayBackendHttpSettings.

Properties

Name Description
AffinityCookieName

Cookie name to use for the affinity cookie.

AuthenticationCertificates

Array of references to application gateway authentication certificates.

ConnectionDraining

Connection draining of the backend http settings resource.

CookieBasedAffinity

Cookie based affinity.

ETag

A unique read-only string that changes whenever the resource is updated.

HostName

Host header to be sent to the backend servers.

Id

Resource ID.

IsDedicatedBackendConnectionEnabled

Enable or disable dedicated connection per backend server. Default is set to false.

IsValidateCertChainAndExpiryEnabled

Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true.

IsValidateSniEnabled

When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true.

Name

Resource name.

Path

Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

PickHostNameFromBackendAddress

Whether to pick host header should be picked from the host name of the backend server. Default value is false.

Port

The destination port on the backend.

ProbeEnabled

Whether the probe is enabled. Default value is false.

ProbeId

Gets or sets Id.

Protocol

The protocol used to communicate with the backend.

ProvisioningState

The provisioning state of the backend HTTP settings resource.

RequestTimeoutInSeconds

Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

ResourceType

Resource type.

SniName

Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null.

TrustedRootCertificates

Array of references to application gateway trusted root certificates.

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableConstruct)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of ApplicationGatewayBackendHttpSettings.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableConstruct)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to