network_bootstrap_interfaces

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

Overview

Name	network_bootstrap_interfaces
Type	Resource
Id	azure_extras.managed_network_fabric.network_bootstrap_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	Connected to information of the device.
description	string	Description of the interface.
interfaceType	string	Type of the interface. Known values are: "Management" and "Data". (Management, Data)
ipv4Address	string	IPv4Address of the interface.
ipv6Address	string	IPv6Address of the interface.
physicalIdentifier	string	Physical identifier of the device.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
serialNumber	string	Serial number of the interface. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.
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_bootstrap_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	Connected to information of the device.
description	string	Description of the interface.
interfaceType	string	Type of the interface. Known values are: "Management" and "Data". (Management, Data)
ipv4Address	string	IPv4Address of the interface.
ipv6Address	string	IPv6Address of the interface.
physicalIdentifier	string	Physical identifier of the device.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
serialNumber	string	Serial number of the interface. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.
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_bootstrap_device_name, network_bootstrap_interface_name, subscription_id		Get the Network Bootstrap Interface resource details.
list_by_network_bootstrap_device	select	resource_group_name, network_bootstrap_device_name, subscription_id		List all the Network Bootstrap Interface resources in a given resource group.
create	insert	resource_group_name, network_bootstrap_device_name, network_bootstrap_interface_name, subscription_id, properties		Create a Network Bootstrap Interface resource.
update	update	resource_group_name, network_bootstrap_device_name, network_bootstrap_interface_name, subscription_id		Update certain properties of the Network Bootstrap Interface resource.
delete	delete	resource_group_name, network_bootstrap_device_name, network_bootstrap_interface_name, subscription_id		Delete the Network Bootstrap Interface resource.
update_administrative_state	exec	resource_group_name, network_bootstrap_device_name, network_bootstrap_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_bootstrap_device_name	string	Name of the Network Bootstrap Device. Required.
network_bootstrap_interface_name	string	Name of the Network Bootstrap 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 Bootstrap Interface resource details.

SELECT
id,
name,
additionalDescription,
administrativeState,
annotation,
configurationState,
connectedTo,
description,
interfaceType,
ipv4Address,
ipv6Address,
physicalIdentifier,
provisioningState,
serialNumber,
systemData,
type
FROM azure_extras.managed_network_fabric.network_bootstrap_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_bootstrap_device_name = '{{ network_bootstrap_device_name }}' -- required
AND network_bootstrap_interface_name = '{{ network_bootstrap_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_network_bootstrap_device

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

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

INSERT examples

create

Create a Network Bootstrap Interface resource.

INSERT INTO azure_extras.managed_network_fabric.network_bootstrap_interfaces (
properties,
resource_group_name,
network_bootstrap_device_name,
network_bootstrap_interface_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ network_bootstrap_device_name }}',
'{{ network_bootstrap_interface_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_bootstrap_interfaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_bootstrap_interfaces resource.
  - name: network_bootstrap_device_name
    value: "{{ network_bootstrap_device_name }}"
    description: Required parameter for the network_bootstrap_interfaces resource.
  - name: network_bootstrap_interface_name
    value: "{{ network_bootstrap_interface_name }}"
    description: Required parameter for the network_bootstrap_interfaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_bootstrap_interfaces resource.
  - name: properties
    description: |
      The NetworkBootstrapInterface properties. Required.
    value:
      annotation: "{{ annotation }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"
      configurationState: "{{ configurationState }}"
      physicalIdentifier: "{{ physicalIdentifier }}"
      connectedTo: "{{ connectedTo }}"
      interfaceType: "{{ interfaceType }}"
      description: "{{ description }}"
      additionalDescription: "{{ additionalDescription }}"
      ipv4Address: "{{ ipv4Address }}"
      ipv6Address: "{{ ipv6Address }}"
      serialNumber: "{{ serialNumber }}"

UPDATE examples

update

Update certain properties of the Network Bootstrap Interface resource.

UPDATE azure_extras.managed_network_fabric.network_bootstrap_interfaces
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_bootstrap_device_name = '{{ network_bootstrap_device_name }}' --required
AND network_bootstrap_interface_name = '{{ network_bootstrap_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the Network Bootstrap Interface resource.

DELETE FROM azure_extras.managed_network_fabric.network_bootstrap_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_bootstrap_device_name = '{{ network_bootstrap_device_name }}' --required
AND network_bootstrap_interface_name = '{{ network_bootstrap_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_bootstrap_interfaces.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_bootstrap_device_name='{{ network_bootstrap_device_name }}' --required, 
@network_bootstrap_interface_name='{{ network_bootstrap_interface_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;