network_interface_ip_configurations

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

Overview

Name	network_interface_ip_configurations
Type	Resource
Id	azure.network.network_interface_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.
applicationGatewayBackendAddressPools	array	The reference to ApplicationGatewayBackendAddressPool resource.
applicationSecurityGroups	array	Application security groups in which the IP configuration is included.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayLoadBalancer	object	Reference to another subresource.
loadBalancerBackendAddressPools	array	The reference to LoadBalancerBackendAddressPool resource.
loadBalancerInboundNatRules	array	A list of references of LoadBalancerInboundNatRules.
primary	boolean	Whether this is a primary customer address on the network interface.
privateIPAddress	string	Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format /.
privateIPAddressPrefixLength	integer	The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address.
privateIPAddressVersion	string	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
privateIPAllocationMethod	string	The private IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
privateLinkConnectionProperties	object	PrivateLinkConnection properties for the network interface.
provisioningState	string	The provisioning state of the network interface IP configuration. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	Public IP address bound to the IP configuration.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.
virtualNetworkTaps	array	The reference to Virtual Network Taps.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
applicationGatewayBackendAddressPools	array	The reference to ApplicationGatewayBackendAddressPool resource.
applicationSecurityGroups	array	Application security groups in which the IP configuration is included.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayLoadBalancer	object	Reference to another subresource.
loadBalancerBackendAddressPools	array	The reference to LoadBalancerBackendAddressPool resource.
loadBalancerInboundNatRules	array	A list of references of LoadBalancerInboundNatRules.
primary	boolean	Whether this is a primary customer address on the network interface.
privateIPAddress	string	Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format /.
privateIPAddressPrefixLength	integer	The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address.
privateIPAddressVersion	string	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
privateIPAllocationMethod	string	The private IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
privateLinkConnectionProperties	object	PrivateLinkConnection properties for the network interface.
provisioningState	string	The provisioning state of the network interface IP configuration. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	Public IP address bound to the IP configuration.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.
virtualNetworkTaps	array	The reference to Virtual Network Taps.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_interface_name, ip_configuration_name, subscription_id		Gets the specified network interface ip configuration.
list	select	resource_group_name, network_interface_name, subscription_id		Get all ip configurations in a network interface.

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
ip_configuration_name	string	The name of the ip configuration. Required.
network_interface_name	string	The name of the network interface. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified network interface ip configuration.

SELECT
id,
name,
applicationGatewayBackendAddressPools,
applicationSecurityGroups,
etag,
gatewayLoadBalancer,
loadBalancerBackendAddressPools,
loadBalancerInboundNatRules,
primary,
privateIPAddress,
privateIPAddressPrefixLength,
privateIPAddressVersion,
privateIPAllocationMethod,
privateLinkConnectionProperties,
provisioningState,
publicIPAddress,
subnet,
type,
virtualNetworkTaps
FROM azure.network.network_interface_ip_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND ip_configuration_name = '{{ ip_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all ip configurations in a network interface.

SELECT
id,
name,
applicationGatewayBackendAddressPools,
applicationSecurityGroups,
etag,
gatewayLoadBalancer,
loadBalancerBackendAddressPools,
loadBalancerInboundNatRules,
primary,
privateIPAddress,
privateIPAddressPrefixLength,
privateIPAddressVersion,
privateIPAllocationMethod,
privateLinkConnectionProperties,
provisioningState,
publicIPAddress,
subnet,
type,
virtualNetworkTaps
FROM azure.network.network_interface_ip_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;