network_devices

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

Overview

Name	network_devices
Type	Resource
Id	azure.managed_network_fabric.network_devices

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

List all NetworkDevices under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_subscription

List all NetworkDevices under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
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, networkDeviceName		Gets the Network Device resource details.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all the Network Device resources in a given resource group.
list_by_subscription	select	subscriptionId		List all the Network Device resources in a given subscription.
create	insert	subscriptionId, resourceGroupName, networkDeviceName, data__properties		Create a Network Device resource
update	update	subscriptionId, resourceGroupName, networkDeviceName		Update certain properties of the Network Device resource.
delete	delete	subscriptionId, resourceGroupName, networkDeviceName		Delete the Network Device resource.
reboot	exec	subscriptionId, resourceGroupName, networkDeviceName		Reboot the Network Device.
refresh_configuration	exec	subscriptionId, resourceGroupName, networkDeviceName		Refreshes the configuration the Network Device.
upgrade	exec	subscriptionId, resourceGroupName, networkDeviceName		Upgrades the version of the Network Device.

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
networkDeviceName	string	Name of the Network Device.
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 the Network Device resource details.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.network_devices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkDeviceName = '{{ networkDeviceName }}' -- required
;

list_by_resource_group

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

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.network_devices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List all the Network Device resources in a given subscription.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.network_devices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Create a Network Device resource

INSERT INTO azure.managed_network_fabric.network_devices (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
networkDeviceName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkDeviceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_devices
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the network_devices resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_devices resource.
    - name: networkDeviceName
      value: string
      description: Required parameter for the network_devices resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update certain properties of the Network Device resource.

UPDATE azure.managed_network_fabric.network_devices
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkDeviceName = '{{ networkDeviceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete the Network Device resource.

DELETE FROM azure.managed_network_fabric.network_devices
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkDeviceName = '{{ networkDeviceName }}' --required
;

Lifecycle Methods

reboot

Reboot the Network Device.

EXEC azure.managed_network_fabric.network_devices.reboot 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkDeviceName='{{ networkDeviceName }}' --required 
@@json=
'{
"rebootType": "{{ rebootType }}"
}'
;

refresh_configuration

Refreshes the configuration the Network Device.

EXEC azure.managed_network_fabric.network_devices.refresh_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkDeviceName='{{ networkDeviceName }}' --required
;

upgrade

Upgrades the version of the Network Device.

EXEC azure.managed_network_fabric.network_devices.upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkDeviceName='{{ networkDeviceName }}' --required 
@@json=
'{
"version": "{{ version }}"
}'
;