devices

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

Overview

Name	devices
Type	Resource
Id	azure.edge_gateway.devices

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
update	update	resource_group_name, device_name, subscription_id	accept-language	Modifies a Data Box Edge/Gateway resource.
get_raw	exec	resource_group_name, device_name, subscription_id	accept-language	Gets the properties of the data box edge/gateway device.
list_by_subscription	exec	subscription_id	accept-language, $expand	Gets all the data box edge/gateway devices in a subscription.
list_by_resource_group	exec	resource_group_name, subscription_id	accept-language, $expand	Gets all the data box edge/gateway devices in a resource group.
get_extended_information	exec	resource_group_name, device_name, subscription_id	accept-language	Gets additional information for the specified data box edge/gateway device.
get_network_settings	exec	resource_group_name, device_name, subscription_id	accept-language	Gets the network settings of the specified data box edge/gateway device.
get_update_summary	exec	resource_group_name, device_name, subscription_id	accept-language	Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.
download_updates	exec			Downloads the updates on a data box edge/gateway device.
install_updates	exec			Installs the updates on the data box edge/gateway device.
scan_for_updates	exec			Scans for updates on a data box edge/gateway device.
create_or_update_security_settings	exec			Updates the security settings on a data box edge/gateway device.
upload_certificate	exec	resource_group_name, device_name, subscription_id	accept-language	Uploads registration certificate for the 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
device_name	string	The device name.
resource_group_name	string	The resource group name.
subscription_id	string
$expand	string	Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.
accept-language	string

UPDATE examples

update

Modifies a Data Box Edge/Gateway resource.

UPDATE azure.edge_gateway.devices
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND device_name = '{{ device_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND accept-language = '{{ accept-language}}';

Lifecycle Methods

get_raw

Gets the properties of the data box edge/gateway device.

EXEC azure.edge_gateway.devices.get_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}'
;

list_by_subscription

Gets all the data box edge/gateway devices in a subscription.

EXEC azure.edge_gateway.devices.list_by_subscription 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}', 
@$expand='{{ $expand }}'
;

list_by_resource_group

Gets all the data box edge/gateway devices in a resource group.

EXEC azure.edge_gateway.devices.list_by_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}', 
@$expand='{{ $expand }}'
;

get_extended_information

Gets additional information for the specified data box edge/gateway device.

EXEC azure.edge_gateway.devices.get_extended_information 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}'
;

get_network_settings

Gets the network settings of the specified data box edge/gateway device.

EXEC azure.edge_gateway.devices.get_network_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}'
;

get_update_summary

Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.

EXEC azure.edge_gateway.devices.get_update_summary 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}'
;

download_updates

Downloads the updates on a data box edge/gateway device.

EXEC azure.edge_gateway.devices.download_updates 

;

install_updates

Installs the updates on the data box edge/gateway device.

EXEC azure.edge_gateway.devices.install_updates 

;

scan_for_updates

Scans for updates on a data box edge/gateway device.

EXEC azure.edge_gateway.devices.scan_for_updates 

;

create_or_update_security_settings

Updates the security settings on a data box edge/gateway device.

EXEC azure.edge_gateway.devices.create_or_update_security_settings 

;

upload_certificate

Uploads registration certificate for the device.

EXEC azure.edge_gateway.devices.upload_certificate 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@accept-language='{{ accept-language }}'
;