devices

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

Overview

Name	devices
Type	Resource
Id	azure.data_box_edge.devices

Fields

vw_devices

Name	Datatype	Description
id	text	The path ID that uniquely identifies the object.
name	text	The object name.
description	text	field from the properties object
configured_role_types	text	field from the properties object
culture	text	field from the properties object
data_box_edge_device_status	text	field from the properties object
data_residency	text	field from the properties object
deviceName	text	field from the properties object
device_hcs_version	text	field from the properties object
device_local_capacity	text	field from the properties object
device_model	text	field from the properties object
device_software_version	text	field from the properties object
device_type	text	field from the properties object
edge_profile	text	field from the properties object
etag	text	The etag for the devices.
friendly_name	text	field from the properties object
identity	text	Msi identity details of the resource
kind	text	The kind of the device.
kubernetes_workload_profile	text	field from the properties object
location	text	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.
model_description	text	field from the properties object
node_count	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_move_details	text	field from the properties object
serial_number	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
time_zone	text	field from the properties object
type	text	The hierarchical type of the object.

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 details 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 resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the 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

Name	Accessible by	Required Params	Description
get	SELECT	deviceName, resourceGroupName, subscriptionId	Gets the properties of the Data Box Edge/Data Box Gateway device.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
list_by_subscription	SELECT	subscriptionId	Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
create_or_update	INSERT	deviceName, resourceGroupName, subscriptionId, data__location	Creates or updates a Data Box Edge/Data Box Gateway resource.
delete	DELETE	deviceName, resourceGroupName, subscriptionId	Deletes the Data Box Edge/Data Box Gateway device.
update	UPDATE	deviceName, resourceGroupName, subscriptionId	Modifies a Data Box Edge/Data Box Gateway resource.
download_updates	EXEC	deviceName, resourceGroupName, subscriptionId
generate_certificate	EXEC	deviceName, resourceGroupName, subscriptionId	Generates certificate for activation key.
install_updates	EXEC	deviceName, resourceGroupName, subscriptionId
scan_for_updates	EXEC	deviceName, resourceGroupName, subscriptionId
upload_certificate	EXEC	deviceName, resourceGroupName, subscriptionId, data__properties	Uploads registration certificate for the device.

SELECT examples

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

vw_devices

SELECT
id,
name,
description,
configured_role_types,
culture,
data_box_edge_device_status,
data_residency,
deviceName,
device_hcs_version,
device_local_capacity,
device_model,
device_software_version,
device_type,
edge_profile,
etag,
friendly_name,
identity,
kind,
kubernetes_workload_profile,
location,
model_description,
node_count,
resourceGroupName,
resource_move_details,
serial_number,
sku,
subscriptionId,
system_data,
tags,
time_zone,
type
FROM azure.data_box_edge.vw_devices
WHERE subscriptionId = '{{ subscriptionId }}';

devices

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

INSERT example

Use the following StackQL query and manifest file to create a new devices resource.

All Properties

/*+ create */
INSERT INTO azure.data_box_edge.devices (
deviceName,
resourceGroupName,
subscriptionId,
data__location,
location,
tags,
sku,
etag,
identity,
properties
)
SELECT 
'{{ deviceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ etag }}',
'{{ identity }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: etag
      value: string
    - name: identity
      value:
        - name: type
          value: string
        - name: principalId
          value: string
        - name: tenantId
          value: string
    - name: kind
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: dataBoxEdgeDeviceStatus
          value: string
        - name: serialNumber
          value: string
        - name: description
          value: string
        - name: modelDescription
          value: string
        - name: deviceType
          value: string
        - name: friendlyName
          value: string
        - name: culture
          value: string
        - name: deviceModel
          value: string
        - name: deviceSoftwareVersion
          value: string
        - name: deviceLocalCapacity
          value: integer
        - name: timeZone
          value: string
        - name: deviceHcsVersion
          value: string
        - name: configuredRoleTypes
          value:
            - string
        - name: nodeCount
          value: integer
        - name: resourceMoveDetails
          value:
            - name: operationInProgress
              value: string
            - name: operationInProgressLockTimeoutInUTC
              value: string
        - name: edgeProfile
          value:
            - name: subscription
              value:
                - name: registrationId
                  value: string
                - name: id
                  value: string
                - name: state
                  value: string
                - name: registrationDate
                  value: string
                - name: subscriptionId
                  value: string
                - name: properties
                  value:
                    - name: tenantId
                      value: string
                    - name: locationPlacementId
                      value: string
                    - name: quotaId
                      value: string
                    - name: serializedDetails
                      value: string
                    - name: registeredFeatures
                      value:
                        - - name: name
                            value: string
                          - name: state
                            value: string
        - name: dataResidency
          value:
            - name: type
              value: string
        - name: kubernetesWorkloadProfile
          value: string

UPDATE example

Updates a devices resource.

/*+ update */
UPDATE azure.data_box_edge.devices
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified devices resource.

/*+ delete */
DELETE FROM azure.data_box_edge.devices
WHERE deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';