Skip to main content

azLoadBalancer

Deploy an Azure Load Balancer to the relevant subscription.

Attributes

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
ResourceGroupNameStringYes
LocationStringYes
SkuStringNoBasicBasic
Standard
Gateway
TypeStringNoInternal, PublicInternal
TierStringNoRegional, GlobalRegional
FrontEndIPConfigObjectNo
BackEndPoolObjectNo
HealthProbeObjectNo
ConfigRuleObjectNo
TagObjectNo
LockObjectNo

FrontEndIPConfig

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
PublicIPObjectNo

PublicIP

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
VNetNameStringNoDefaults to RG of resource

BackEndPool

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes

HealthProbe

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
ProtocolStringYestcp, http, https
PortNumberYes
IntervalInSecondsNumberYes
ProbeCountNumberYes
ProbeThresholdStringNo
RequestPathStringNoMandatory for protocols http, https

ConfigRule

Input by YAML

Object model for YAML deployment:

azLoadBalancer:
# Mandatory
- Name: 'string'
ResourceGroupName: 'string'
Location: 'string'
# Optional
Sku: 'string' # Basic (D), Standard, Gateway
Type: 'string' # Internal (D), Public
Tier: 'string' # Regional (D), Global
Tag:
'keyvalue-pairs'
Lock:
- Name: 'string'
Level: 'string' # CanNotDelete, ReadOnly
Notes: 'string'
FrontEndIPConfig:
- Name: 'string'
PublicIp:
Name: 'string'
VNetName: 'string'
BackEndPool:
- Name: 'string'
HealthProbe:
# Mandatory
- Name: 'string'
Protocol: 'string'
Port: number
IntervalInSeconds: number
ProbeCount: number
# Optional
ProbeThreshold: number
RequestPath: 'string'
- Name: 'string'
Protocol: 'string'
Port: number
IntervalInSeconds: number
ProbeCount: number
ProbeThreshold: number
RequestPath: 'string'
InboundNATRule:
- Name: 'string'
Protocol: 'string'
FrontEndPort: number
BackEndPort: number
IdleTimeoutInMinutes: number
FloatingIP: boolean # True, False
EnableTcpReset: boolean # True, False
FrontendIpConfiguration: 'string'
FrontendPortRangeStart:
FrontendPortRangeEnd:
BackendAddressPool:
ConfigRule:
- Name: 'string'
BackendAddressPool:
Probe:
Protocol:
FrontEndPort: number
BackEndPort: number
IdleTimeoutInMinutes: number
FloatingIP: boolean # True, False
LoadDistribution:

Input by JSON

Object model for JSON deployment:

{
"azLoadBalancer": [
{
"Name": "string",
"ResourceGroupName": "string",
"Location": "string",
"Sku": "string",
"SkuCapacity": number,
"RetentionInDays": number,
"Network": [
{
"PublicAccessIngestion": boolean,
"PublicAccessQuery": boolean
}
]
"Tag": {
"key": "string"
},
"Lock": [
{
"Name": "string",
"Level": "string",
"Notes": "string"
}
]
}
]
}