interfaces

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

Overview

Name	interfaces
Type	Resource
Id	azure.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"

list_all

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, networkInterfaceName, subscriptionId	$expand	Gets information about the specified network interface.
list	select	resourceGroupName, subscriptionId		Gets all network interfaces in a resource group.
list_all	select	subscriptionId		Gets all network interfaces in a subscription.
create_or_update	insert	resourceGroupName, networkInterfaceName, subscriptionId		Creates or updates a network interface.
delete	delete	resourceGroupName, networkInterfaceName, subscriptionId		Deletes the specified network interface.
update_tags	exec	resourceGroupName, networkInterfaceName, subscriptionId		Updates a network interface tags.

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.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets information about the specified network interface.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.interfaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all network interfaces in a resource group.

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

list_all

Gets all network interfaces in a subscription.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.interfaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network interface.

INSERT INTO azure.network.interfaces (
data__extendedLocation,
data__properties,
resourceGroupName,
networkInterfaceName,
subscriptionId
)
SELECT 
'{{ extendedLocation }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ networkInterfaceName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: interfaces
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the interfaces resource.
    - name: networkInterfaceName
      value: string
      description: Required parameter for the interfaces resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the interfaces resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the network interface.
    - name: properties
      value: object
      description: |
        Properties of the network interface.

DELETE examples

delete

Deletes the specified network interface.

DELETE FROM azure.network.interfaces
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND networkInterfaceName = '{{ networkInterfaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates a network interface tags.

EXEC azure.network.interfaces.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkInterfaceName='{{ networkInterfaceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;