network_interfaces

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

Overview

Name	network_interfaces
Type	Resource
Id	azure_extras.managed_network_fabric.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.
additionalDescription	string	Additional description of the interface.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
connectedTo	string	The ARM resource id of the interface or compute server its connected to.
description	string	Description of the interface.
identity	object	The managed service identities assigned to this resource.
interfaceType	string	The Interface Type. Example: Management/Data. Known values are: "Management" and "Data". (Management, Data)
ipv4Address	string	IPv4Address of the interface.
ipv6Address	string	IPv6Address of the interface.
lastOperation	object	Details of the last operation performed on the resource.
networkFabricId	string	Associated Network Fabric Resource ID.
physicalIdentifier	string	Physical Identifier of the network interface.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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_by_network_device

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.
additionalDescription	string	Additional description of the interface.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
connectedTo	string	The ARM resource id of the interface or compute server its connected to.
description	string	Description of the interface.
identity	object	The managed service identities assigned to this resource.
interfaceType	string	The Interface Type. Example: Management/Data. Known values are: "Management" and "Data". (Management, Data)
ipv4Address	string	IPv4Address of the interface.
ipv6Address	string	IPv6Address of the interface.
lastOperation	object	Details of the last operation performed on the resource.
networkFabricId	string	Associated Network Fabric Resource ID.
physicalIdentifier	string	Physical Identifier of the network interface.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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	resource_group_name, network_device_name, network_interface_name, subscription_id		Get the Network Interface resource details.
list_by_network_device	select	resource_group_name, network_device_name, subscription_id		List all the Network Interface resources in a given resource group.
create	insert	resource_group_name, network_device_name, network_interface_name, subscription_id, properties		Create a Network Interface resource.
update	update	resource_group_name, network_device_name, network_interface_name, subscription_id		Update certain properties of the Network Interface resource.
delete	delete	resource_group_name, network_device_name, network_interface_name, subscription_id		Delete the Network Interface resource.
update_administrative_state	exec	resource_group_name, network_device_name, network_interface_name, subscription_id		Update the admin state of the 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_device_name	string	Name of the Network Device. Required.
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

Get the Network Interface resource details.

SELECT
id,
name,
additionalDescription,
administrativeState,
annotation,
configurationState,
connectedTo,
description,
identity,
interfaceType,
ipv4Address,
ipv6Address,
lastOperation,
networkFabricId,
physicalIdentifier,
provisioningState,
systemData,
type
FROM azure_extras.managed_network_fabric.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_device_name = '{{ network_device_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_network_device

List all the Network Interface resources in a given resource group.

SELECT
id,
name,
additionalDescription,
administrativeState,
annotation,
configurationState,
connectedTo,
description,
identity,
interfaceType,
ipv4Address,
ipv6Address,
lastOperation,
networkFabricId,
physicalIdentifier,
provisioningState,
systemData,
type
FROM azure_extras.managed_network_fabric.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_device_name = '{{ network_device_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a Network Interface resource.

INSERT INTO azure_extras.managed_network_fabric.network_interfaces (
properties,
identity,
resource_group_name,
network_device_name,
network_interface_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ resource_group_name }}',
'{{ network_device_name }}',
'{{ network_interface_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
properties,
systemData,
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_device_name
    value: "{{ network_device_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: properties
    description: |
      The NetworkInterface properties. Required.
    value:
      annotation: "{{ annotation }}"
      physicalIdentifier: "{{ physicalIdentifier }}"
      connectedTo: "{{ connectedTo }}"
      interfaceType: "{{ interfaceType }}"
      ipv4Address: "{{ ipv4Address }}"
      ipv6Address: "{{ ipv6Address }}"
      description: "{{ description }}"
      additionalDescription: "{{ additionalDescription }}"
      lastOperation:
        details: "{{ details }}"
      networkFabricId: "{{ networkFabricId }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"
      configurationState: "{{ configurationState }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update certain properties of the Network Interface resource.

UPDATE azure_extras.managed_network_fabric.network_interfaces
SET 
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_device_name = '{{ network_device_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
properties,
systemData,
type;

DELETE examples

delete

Delete the Network Interface resource.

DELETE FROM azure_extras.managed_network_fabric.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_device_name = '{{ network_device_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_administrative_state

Update the admin state of the Network Interface.

EXEC azure_extras.managed_network_fabric.network_interfaces.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_device_name='{{ network_device_name }}' --required, 
@network_interface_name='{{ network_interface_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;