devices

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

Overview

Name	devices
Type	Resource
Id	azure.data_box_edge.devices

Fields

The following fields are returned by SELECT queries:

get

The Data Box Edge/Data Box Gateway device.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
etag	string	The etag for the devices.
identity	object	Msi identity of the resource
kind	string	The kind of the device.
location	string	The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.
properties	object	The properties of the Data Box Edge/Gateway device.
sku	object	The SKU type.
systemData	object	DataBoxEdge Resource
tags	object	The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
type	string	The hierarchical type of the object.

list_by_resource_group

The collection of Data Box Edge/Data Box Gateway devices.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
etag	string	The etag for the devices.
identity	object	Msi identity of the resource
kind	string	The kind of the device.
location	string	The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.
properties	object	The properties of the Data Box Edge/Gateway device.
sku	object	The SKU type.
systemData	object	DataBoxEdge Resource
tags	object	The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
type	string	The hierarchical type of the object.

list_by_subscription

The collection of Data Box Edge/Data Box Gateway devices.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
etag	string	The etag for the devices.
identity	object	Msi identity of the resource
kind	string	The kind of the device.
location	string	The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.
properties	object	The properties of the Data Box Edge/Gateway device.
sku	object	The SKU type.
systemData	object	DataBoxEdge Resource
tags	object	The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, subscriptionId, resourceGroupName		Gets the properties of the Data Box Edge/Data Box Gateway device.
list_by_resource_group	select	subscriptionId, resourceGroupName	$expand	Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
list_by_subscription	select	subscriptionId	$expand	Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
create_or_update	insert	deviceName, subscriptionId, resourceGroupName, data__location		Creates or updates a Data Box Edge/Data Box Gateway resource.
update	update	deviceName, subscriptionId, resourceGroupName		Modifies a Data Box Edge/Data Box Gateway resource.
delete	delete	deviceName, subscriptionId, resourceGroupName		Deletes the Data Box Edge/Data Box Gateway device.
download_updates	exec	deviceName, subscriptionId, resourceGroupName
generate_certificate	exec	deviceName, subscriptionId, resourceGroupName		Generates certificate for activation key.
install_updates	exec	deviceName, subscriptionId, resourceGroupName
scan_for_updates	exec	deviceName, subscriptionId, resourceGroupName
upload_certificate	exec	deviceName, subscriptionId, resourceGroupName, properties		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
deviceName	string	The device name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.
$expand	string	Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.

SELECT examples

get

Gets the properties of the Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.data_box_edge.devices
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_resource_group

Gets all the Data Box Edge/Data Box Gateway devices in a resource group.

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.data_box_edge.devices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_subscription

Gets all the Data Box Edge/Data Box Gateway devices in a subscription.

SELECT
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.data_box_edge.devices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Creates or updates a Data Box Edge/Data Box Gateway resource.

INSERT INTO azure.data_box_edge.devices (
data__location,
data__tags,
data__sku,
data__etag,
data__identity,
data__properties,
deviceName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ sku }}',
'{{ etag }}',
'{{ identity }}',
'{{ properties }}',
'{{ deviceName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: devices
  props:
    - name: deviceName
      value: string
      description: Required parameter for the devices resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the devices resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the devices resource.
    - name: location
      value: string
      description: |
        The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.
    - name: tags
      value: object
      description: |
        The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
    - name: sku
      value: object
      description: |
        The SKU type.
    - name: etag
      value: string
      description: |
        The etag for the devices.
    - name: identity
      value: object
      description: |
        Msi identity of the resource
    - name: properties
      value: object
      description: |
        The properties of the Data Box Edge/Gateway device.

UPDATE examples

update

Modifies a Data Box Edge/Data Box Gateway resource.

UPDATE azure.data_box_edge.devices
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}'
WHERE 
deviceName = '{{ deviceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the Data Box Edge/Data Box Gateway device.

DELETE FROM azure.data_box_edge.devices
WHERE deviceName = '{{ deviceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;

Lifecycle Methods

download_updates

Successfully downloaded the updates on the device.

EXEC azure.data_box_edge.devices.download_updates 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;

generate_certificate

Generates certificate for activation key.

EXEC azure.data_box_edge.devices.generate_certificate 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;

install_updates

Successfully installed updates on the device.

EXEC azure.data_box_edge.devices.install_updates 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;

scan_for_updates

Successfully scanned the device for updates.

EXEC azure.data_box_edge.devices.scan_for_updates 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;

upload_certificate

Uploads registration certificate for the device.

EXEC azure.data_box_edge.devices.upload_certificate 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;