Share via

FrontendIPConfiguration Class

  • Reference

Frontend IP address of the load balancer.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

FrontendIPConfiguration(*, id: str | None = None, name: str | None = None, zones: List[str] | None = None, private_ip_address: str | None = None, private_ip_allocation_method: str | _models.IPAllocationMethod | None = None, private_ip_address_version: str | _models.IPVersion | None = None, subnet: _models.Subnet | None = None, public_ip_address: _models.PublicIPAddress | None = None, public_ip_prefix: _models.SubResource | None = None, gateway_load_balancer: _models.SubResource | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

Default value: None
name
str

The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.

Default value: None
zones
list[str]

A list of availability zones denoting the IP allocated for the resource needs to come from.

Default value: None
private_ip_address
str

The private IP address of the IP configuration.

Default value: None
private_ip_allocation_method
str or IPAllocationMethod

The Private IP allocation method. Known values are: "Static" and "Dynamic".

Default value: None
private_ip_address_version
str or IPVersion

Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Known values are: "IPv4" and "IPv6".

Default value: None
subnet
Subnet

The reference to the subnet resource.

Default value: None
public_ip_address
PublicIPAddress

The reference to the Public IP resource.

Default value: None
public_ip_prefix
SubResource

The reference to the Public IP Prefix resource.

Default value: None
gateway_load_balancer
SubResource

The reference to gateway load balancer frontend IP.

Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
etag
str

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

Type of the resource.
zones
list[str]

A list of availability zones denoting the IP allocated for the resource needs to come from.
inbound_nat_rules
list[SubResource]

An array of references to inbound rules that use this frontend IP.
inbound_nat_pools
list[SubResource]

An array of references to inbound pools that use this frontend IP.
outbound_rules
list[SubResource]

An array of references to outbound rules that use this frontend IP.
load_balancing_rules
list[SubResource]

An array of references to load balancing rules that use this frontend IP.
private_ip_address
str

The private IP address of the IP configuration.
private_ip_allocation_method
str or IPAllocationMethod

The Private IP allocation method. Known values are: "Static" and "Dynamic".
private_ip_address_version
str or IPVersion

Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Known values are: "IPv4" and "IPv6".
subnet
Subnet

The reference to the subnet resource.
public_ip_address
PublicIPAddress

The reference to the Public IP resource.
public_ip_prefix
SubResource

The reference to the Public IP Prefix resource.
gateway_load_balancer
SubResource

The reference to gateway load balancer frontend IP.
provisioning_state
str or ProvisioningState

The provisioning state of the frontend IP configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".