interfaces_virtual_machine_scale_set_network_interfaces

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

Overview

Name	interfaces_virtual_machine_scale_set_network_interfaces
Type	Resource
Id	azure.network.interfaces_virtual_machine_scale_set_network_interfaces

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting NetworkInterface resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
properties	object	Properties of the network interface.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. The operation returns a list of NetworkInterface resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
properties	object	Properties of the network interface.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualMachineScaleSetName, virtualmachineIndex, networkInterfaceName, subscriptionId	api-version, $expand	Get the specified network interface in a virtual machine scale set.
list	select	resourceGroupName, virtualMachineScaleSetName, subscriptionId	api-version	Gets all network interfaces 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
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 in a virtual machine scale set.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.interfaces_virtual_machine_scale_set_network_interfaces
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 }}'
;

list

Gets all network interfaces in a virtual machine scale set.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.interfaces_virtual_machine_scale_set_network_interfaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineScaleSetName = '{{ virtualMachineScaleSetName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;