interfaces_virtual_machine_scale_set_ip_configurations

Creates, updates, deletes, gets or lists an interfaces_virtual_machine_scale_set_ip_configurations resource.

Overview

Name	interfaces_virtual_machine_scale_set_ip_configurations
Type	Resource
Id	azure.network.interfaces_virtual_machine_scale_set_ip_configurations

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting NetworkInterfaceIPConfiguration resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Network interface IP configuration properties.
type	string	Resource type.

list

Request successful. The operation returns the list of resulting NetworkInterfaceIPConfigurations resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Network interface IP configuration properties.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualMachineScaleSetName, virtualmachineIndex, networkInterfaceName, ipConfigurationName, subscriptionId	api-version, $expand	Get the specified network interface ip configuration in a virtual machine scale set.
list	select	resourceGroupName, virtualMachineScaleSetName, virtualmachineIndex, networkInterfaceName, subscriptionId	api-version, $expand	Get the specified network interface ip configuration in a virtual machine scale set.

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
ipConfigurationName	string	The name of the ip configuration.
networkInterfaceName	string	The name of the network interface.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualMachineScaleSetName	string	The name of the virtual machine scale set.
virtualmachineIndex	string	The virtual machine index.
$expand	string	Expands referenced resources.
api-version	string	Client API version.

SELECT examples

get

Get the specified network interface ip configuration in a virtual machine scale set.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.interfaces_virtual_machine_scale_set_ip_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineScaleSetName = '{{ virtualMachineScaleSetName }}' -- required
AND virtualmachineIndex = '{{ virtualmachineIndex }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
AND ipConfigurationName = '{{ ipConfigurationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $expand = '{{ $expand }}'
;

list

Get the specified network interface ip configuration in a virtual machine scale set.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.interfaces_virtual_machine_scale_set_ip_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineScaleSetName = '{{ virtualMachineScaleSetName }}' -- required
AND virtualmachineIndex = '{{ virtualmachineIndex }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $expand = '{{ $expand }}'
;