network_interfaces

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

Overview

Name	network_interfaces
Type	Resource
Id	azure_stack.azure_stack_hci_vm.network_interfaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createFromLocal	boolean	Boolean indicating whether this is a existing local network interface or if one should be created.
dnsSettings	object	DNS Settings for the interface.
extendedLocation	object	The extendedLocation of the resource.
ipConfigurations	array	IPConfigurations - A list of IPConfigurations of the network interface.
location	string	The geo-location where the resource lives. Required.
macAddress	string	MacAddress - The MAC address of the network interface.
networkSecurityGroup	object	NetworkSecurityGroup - Network Security Group attached to the network interface.
provisioningState	string	Provisioning state of the network interface. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of network interfaces.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createFromLocal	boolean	Boolean indicating whether this is a existing local network interface or if one should be created.
dnsSettings	object	DNS Settings for the interface.
extendedLocation	object	The extendedLocation of the resource.
ipConfigurations	array	IPConfigurations - A list of IPConfigurations of the network interface.
location	string	The geo-location where the resource lives. Required.
macAddress	string	MacAddress - The MAC address of the network interface.
networkSecurityGroup	object	NetworkSecurityGroup - Network Security Group attached to the network interface.
provisioningState	string	Provisioning state of the network interface. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of network interfaces.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_all

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createFromLocal	boolean	Boolean indicating whether this is a existing local network interface or if one should be created.
dnsSettings	object	DNS Settings for the interface.
extendedLocation	object	The extendedLocation of the resource.
ipConfigurations	array	IPConfigurations - A list of IPConfigurations of the network interface.
location	string	The geo-location where the resource lives. Required.
macAddress	string	MacAddress - The MAC address of the network interface.
networkSecurityGroup	object	NetworkSecurityGroup - Network Security Group attached to the network interface.
provisioningState	string	Provisioning state of the network interface. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of network interfaces.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, network_interface_name, subscription_id		Gets a network interface.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		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	resource_group_name, network_interface_name, subscription_id, location		The operation to create or update a network interface. Please note some properties can be set only during network interface creation.
update	update	resource_group_name, network_interface_name, subscription_id		The operation to update a network interface.
create_or_update	replace	resource_group_name, network_interface_name, subscription_id, location		The operation to create or update a network interface. Please note some properties can be set only during network interface creation.
delete	delete	resource_group_name, network_interface_name, subscription_id		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
network_interface_name	string	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 a network interface.

SELECT
id,
name,
createFromLocal,
dnsSettings,
extendedLocation,
ipConfigurations,
location,
macAddress,
networkSecurityGroup,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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
id,
name,
createFromLocal,
dnsSettings,
extendedLocation,
ipConfigurations,
location,
macAddress,
networkSecurityGroup,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
createFromLocal,
dnsSettings,
extendedLocation,
ipConfigurations,
location,
macAddress,
networkSecurityGroup,
provisioningState,
status,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.network_interfaces
WHERE subscription_id = '{{ subscription_id }}' -- 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_vm.network_interfaces (
tags,
location,
properties,
extendedLocation,
resource_group_name,
network_interface_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ network_interface_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_interfaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_interfaces resource.
  - name: network_interface_name
    value: "{{ network_interface_name }}"
    description: Required parameter for the network_interfaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_interfaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      ipConfigurations:
        - name: "{{ name }}"
          properties:
            gateway: "{{ gateway }}"
            prefixLength: "{{ prefixLength }}"
            privateIPAddress: "{{ privateIPAddress }}"
            subnet:
              id: "{{ id }}"
      macAddress: "{{ macAddress }}"
      dnsSettings:
        dnsServers:
          - "{{ dnsServers }}"
      createFromLocal: {{ createFromLocal }}
      provisioningState: "{{ provisioningState }}"
      status:
        errorCode: "{{ errorCode }}"
        errorMessage: "{{ errorMessage }}"
        provisioningStatus:
          operationId: "{{ operationId }}"
          status: "{{ status }}"
      networkSecurityGroup:
        id: "{{ id }}"
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

The operation to update a network interface.

UPDATE azure_stack.azure_stack_hci_vm.network_interfaces
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE 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.

REPLACE azure_stack.azure_stack_hci_vm.network_interfaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete a network interface.

DELETE FROM azure_stack.azure_stack_hci_vm.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;