network_interfaces

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

Overview

Name	network_interfaces
Type	Resource
Id	azure_stack.azure_stack_hci.network_interfaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the network interface resource
tags	object	Resource tags.

list

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the network interface resource
tags	object	Resource tags.

list_all

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the network interface resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, networkInterfaceName		Gets a network interface
list	select	subscriptionId, resourceGroupName		Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.
list_all	select	subscriptionId		Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.
create_or_update	insert	subscriptionId, resourceGroupName, networkInterfaceName		The operation to create or update a network interface. Please note some properties can be set only during network interface creation.
update	update	subscriptionId, resourceGroupName, networkInterfaceName		The operation to update a network interface.
delete	delete	subscriptionId, resourceGroupName, networkInterfaceName		The operation to delete 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
networkInterfaceName	string	Name of the network interface
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets a network interface

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.network_interfaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
;

list

Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.network_interfaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.network_interfaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a network interface. Please note some properties can be set only during network interface creation.

INSERT INTO azure_stack.azure_stack_hci.network_interfaces (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
networkInterfaceName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkInterfaceName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_interfaces
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the network_interfaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_interfaces resource.
    - name: networkInterfaceName
      value: string
      description: Required parameter for the network_interfaces resource.
    - name: properties
      value: object
      description: |
        Properties under the network interface resource
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

The operation to update a network interface.

UPDATE azure_stack.azure_stack_hci.network_interfaces
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkInterfaceName = '{{ networkInterfaceName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

The operation to delete a network interface.

DELETE FROM azure_stack.azure_stack_hci.network_interfaces
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkInterfaceName = '{{ networkInterfaceName }}' --required
;