network_bootstrap_devices

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

Overview

Name	network_bootstrap_devices
Type	Resource
Id	azure_extras.managed_network_fabric.network_bootstrap_devices

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.
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)
dhcpV4ServerIpAddress	string	Dhcp server IPv4 Address.
hostName	string	The host name of the device.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
networkDeviceSku	string	Network Bootstrap Device SKU name.
networkFabricId	string	Associated Network Fabric Resource ID.
primaryManagementIpv4Address	string	Primary Management IPv4 Address.
primaryManagementIpv6Address	string	Primary Management IPv6 Address.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
secondaryManagementIpv4Address	string	Secondary Management IPv4 Address.
secondaryManagementIpv6Address	string	Secondary Management IPv6 Address.
serialNumber	string	Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.
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".
version	string	Current version of the device as defined in SKU.

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.
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)
dhcpV4ServerIpAddress	string	Dhcp server IPv4 Address.
hostName	string	The host name of the device.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
networkDeviceSku	string	Network Bootstrap Device SKU name.
networkFabricId	string	Associated Network Fabric Resource ID.
primaryManagementIpv4Address	string	Primary Management IPv4 Address.
primaryManagementIpv6Address	string	Primary Management IPv6 Address.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
secondaryManagementIpv4Address	string	Secondary Management IPv4 Address.
secondaryManagementIpv6Address	string	Secondary Management IPv6 Address.
serialNumber	string	Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.
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".
version	string	Current version of the device as defined in SKU.

list_by_subscription

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.
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)
dhcpV4ServerIpAddress	string	Dhcp server IPv4 Address.
hostName	string	The host name of the device.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
networkDeviceSku	string	Network Bootstrap Device SKU name.
networkFabricId	string	Associated Network Fabric Resource ID.
primaryManagementIpv4Address	string	Primary Management IPv4 Address.
primaryManagementIpv6Address	string	Primary Management IPv6 Address.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
secondaryManagementIpv4Address	string	Secondary Management IPv4 Address.
secondaryManagementIpv6Address	string	Secondary Management IPv6 Address.
serialNumber	string	Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.
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".
version	string	Current version of the device as defined in SKU.

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, subscription_id		Gets a Network Bootstrap Device resource details.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the Network Bootstrap Device resources in a given resource group.
list_by_subscription	select	subscription_id		List all the Network Bootstrap Device resources in a given subscription.
create	insert	resource_group_name, network_bootstrap_device_name, subscription_id, location, properties		Creates a Network Bootstrap Device resource.
update	update	resource_group_name, network_bootstrap_device_name, subscription_id		Update certain properties of the Network Bootstrap Device resource.
delete	delete	resource_group_name, network_bootstrap_device_name, subscription_id		Deletes a Network Bootstrap Device resource.
reboot	exec	resource_group_name, network_bootstrap_device_name, subscription_id		Reboot the Network Bootstrap Device.
refresh_configuration	exec	resource_group_name, network_bootstrap_device_name, subscription_id		Refreshes the configuration of Network Bootstrap Device.
upgrade	exec	resource_group_name, network_bootstrap_device_name, subscription_id		Upgrades the version of the Network Bootstrap Device.
update_administrative_state	exec	resource_group_name, network_bootstrap_device_name, subscription_id		Updates the Administrative state of the Network Bootstrap Device.
resync_passwords	exec	resource_group_name, network_bootstrap_device_name, subscription_id		Resync the latest passwords to the Network Bootstrap Device. Updates the Network Bootstrap Device to use the latest passwords. Does not generate new passwords. Allows network bootstrap devices missed during a previous password rotation to be brought back into sync.

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.
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 Bootstrap Device resource details.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
dhcpV4ServerIpAddress,
hostName,
identity,
location,
networkDeviceSku,
networkFabricId,
primaryManagementIpv4Address,
primaryManagementIpv6Address,
provisioningState,
secondaryManagementIpv4Address,
secondaryManagementIpv6Address,
serialNumber,
systemData,
tags,
type,
version
FROM azure_extras.managed_network_fabric.network_bootstrap_devices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_bootstrap_device_name = '{{ network_bootstrap_device_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the Network Bootstrap Device resources in a given resource group.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
dhcpV4ServerIpAddress,
hostName,
identity,
location,
networkDeviceSku,
networkFabricId,
primaryManagementIpv4Address,
primaryManagementIpv6Address,
provisioningState,
secondaryManagementIpv4Address,
secondaryManagementIpv6Address,
serialNumber,
systemData,
tags,
type,
version
FROM azure_extras.managed_network_fabric.network_bootstrap_devices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all the Network Bootstrap Device resources in a given subscription.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
dhcpV4ServerIpAddress,
hostName,
identity,
location,
networkDeviceSku,
networkFabricId,
primaryManagementIpv4Address,
primaryManagementIpv6Address,
provisioningState,
secondaryManagementIpv4Address,
secondaryManagementIpv6Address,
serialNumber,
systemData,
tags,
type,
version
FROM azure_extras.managed_network_fabric.network_bootstrap_devices
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a Network Bootstrap Device resource.

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

Manifest

# Description fields are for documentation purposes
- name: network_bootstrap_devices
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_bootstrap_devices resource.
  - name: network_bootstrap_device_name
    value: "{{ network_bootstrap_device_name }}"
    description: Required parameter for the network_bootstrap_devices resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_bootstrap_devices 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 NetworkBootstrapDevice properties. Required.
    value:
      annotation: "{{ annotation }}"
      hostName: "{{ hostName }}"
      serialNumber: "{{ serialNumber }}"
      version: "{{ version }}"
      networkDeviceSku: "{{ networkDeviceSku }}"
      networkFabricId: "{{ networkFabricId }}"
      secondaryManagementIpv4Address: "{{ secondaryManagementIpv4Address }}"
      dhcpV4ServerIpAddress: "{{ dhcpV4ServerIpAddress }}"
      primaryManagementIpv6Address: "{{ primaryManagementIpv6Address }}"
      secondaryManagementIpv6Address: "{{ secondaryManagementIpv6Address }}"
      provisioningState: "{{ provisioningState }}"
      primaryManagementIpv4Address: "{{ primaryManagementIpv4Address }}"
      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 Bootstrap Device resource.

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

DELETE examples

delete

Deletes a Network Bootstrap Device resource.

DELETE FROM azure_extras.managed_network_fabric.network_bootstrap_devices
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_bootstrap_device_name = '{{ network_bootstrap_device_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

reboot

Reboot the Network Bootstrap Device.

EXEC azure_extras.managed_network_fabric.network_bootstrap_devices.reboot 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_bootstrap_device_name='{{ network_bootstrap_device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

refresh_configuration

Refreshes the configuration of Network Bootstrap Device.

EXEC azure_extras.managed_network_fabric.network_bootstrap_devices.refresh_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_bootstrap_device_name='{{ network_bootstrap_device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

upgrade

Upgrades the version of the Network Bootstrap Device.

EXEC azure_extras.managed_network_fabric.network_bootstrap_devices.upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_bootstrap_device_name='{{ network_bootstrap_device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"version": "{{ version }}"
}'
;

update_administrative_state

Updates the Administrative state of the Network Bootstrap Device.

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

resync_passwords

Resync the latest passwords to the Network Bootstrap Device. Updates the Network Bootstrap Device to use the latest passwords. Does not generate new passwords. Allows network bootstrap devices missed during a previous password rotation to be brought back into sync.

EXEC azure_extras.managed_network_fabric.network_bootstrap_devices.resync_passwords 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_bootstrap_device_name='{{ network_bootstrap_device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;