load_balancer_frontend_ip_configurations

Creates, updates, deletes, gets or lists a load_balancer_frontend_ip_configurations resource.

Overview

Name	load_balancer_frontend_ip_configurations
Type	Resource
Id	azure.network.load_balancer_frontend_ip_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
ddosSettings	object	The DDoS protection settings associated with the frontend IP configuration.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayLoadBalancer	object	Reference to another subresource.
inboundNatPools	array	An array of references to inbound pools that use this frontend IP.
inboundNatRules	array	An array of references to inbound rules that use this frontend IP.
loadBalancingRules	array	An array of references to load balancing rules that use this frontend IP.
outboundRules	array	An array of references to outbound rules that use this frontend IP.
privateIPAddress	string	The private IP address of the IP configuration.
privateIPAddressVersion	string	Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
privateIPAllocationMethod	string	The Private IP allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
provisioningState	string	The provisioning state of the frontend IP configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	The reference to the Public IP resource.
publicIPPrefix	object	Reference to another subresource.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
ddosSettings	object	The DDoS protection settings associated with the frontend IP configuration.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayLoadBalancer	object	Reference to another subresource.
inboundNatPools	array	An array of references to inbound pools that use this frontend IP.
inboundNatRules	array	An array of references to inbound rules that use this frontend IP.
loadBalancingRules	array	An array of references to load balancing rules that use this frontend IP.
outboundRules	array	An array of references to outbound rules that use this frontend IP.
privateIPAddress	string	The private IP address of the IP configuration.
privateIPAddressVersion	string	Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
privateIPAllocationMethod	string	The Private IP allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
provisioningState	string	The provisioning state of the frontend IP configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	The reference to the Public IP resource.
publicIPPrefix	object	Reference to another subresource.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, load_balancer_name, frontend_ip_configuration_name, subscription_id		Gets load balancer frontend IP configuration.
list	select	resource_group_name, load_balancer_name, subscription_id		Gets all the load balancer frontend IP configurations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
frontend_ip_configuration_name	string	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. Required.
load_balancer_name	string	The name of the load balancer. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets load balancer frontend IP configuration.

SELECT
id,
name,
ddosSettings,
etag,
gatewayLoadBalancer,
inboundNatPools,
inboundNatRules,
loadBalancingRules,
outboundRules,
privateIPAddress,
privateIPAddressVersion,
privateIPAllocationMethod,
provisioningState,
publicIPAddress,
publicIPPrefix,
subnet,
type,
zones
FROM azure.network.load_balancer_frontend_ip_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND frontend_ip_configuration_name = '{{ frontend_ip_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the load balancer frontend IP configurations.

SELECT
id,
name,
ddosSettings,
etag,
gatewayLoadBalancer,
inboundNatPools,
inboundNatRules,
loadBalancingRules,
outboundRules,
privateIPAddress,
privateIPAddressVersion,
privateIPAllocationMethod,
provisioningState,
publicIPAddress,
publicIPPrefix,
subnet,
type,
zones
FROM azure.network.load_balancer_frontend_ip_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;