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

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.
configuredRoleTypes	array	Type of compute roles configured.
culture	string	The Data Box Edge/Gateway device culture.
dataBoxEdgeDeviceStatus	string	The status of the Data Box Edge/Gateway device. Known values are: "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected", and "Maintenance". (ReadyToSetup, Online, Offline, NeedsAttention, Disconnected, PartiallyDisconnected, Maintenance)
dataResidency	object	The details of data-residency related properties for this resource.
description	string	The Description of the Data Box Edge/Gateway device.
deviceHcsVersion	string	The device software version number of the device (eg: 1.2.18105.6).
deviceLocalCapacity	integer	The Data Box Edge/Gateway device local capacity in MB.
deviceModel	string	The Data Box Edge/Gateway device model.
deviceSoftwareVersion	string	The Data Box Edge/Gateway device software version.
deviceType	string	The type of the Data Box Edge/Gateway device. "DataBoxEdgeDevice" (DataBoxEdgeDevice)
edgeProfile	object	The details of Edge Profile for this resource.
etag	string	The etag for the devices.
friendlyName	string	The Data Box Edge/Gateway device name.
identity	object	Msi identity of the resource.
kind	string	The kind of the device. Known values are: "AzureDataBoxGateway", "AzureStackEdge", "AzureStackHub", and "AzureModularDataCentre". (AzureDataBoxGateway, AzureStackEdge, AzureStackHub, AzureModularDataCentre)
kubernetesWorkloadProfile	string	Kubernetes Workload Profile.
location	string	The geo-location where the resource lives. Required.
modelDescription	string	The description of the Data Box Edge/Gateway device model.
nodeCount	integer	The number of nodes in the cluster.
resourceMoveDetails	object	The details of the move operation on this resource.
serialNumber	string	The Serial Number of Data Box Edge/Gateway device.
sku	object	The SKU type.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeZone	string	The Data Box Edge/Gateway device timezone.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
configuredRoleTypes	array	Type of compute roles configured.
culture	string	The Data Box Edge/Gateway device culture.
dataBoxEdgeDeviceStatus	string	The status of the Data Box Edge/Gateway device. Known values are: "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected", and "Maintenance". (ReadyToSetup, Online, Offline, NeedsAttention, Disconnected, PartiallyDisconnected, Maintenance)
dataResidency	object	The details of data-residency related properties for this resource.
description	string	The Description of the Data Box Edge/Gateway device.
deviceHcsVersion	string	The device software version number of the device (eg: 1.2.18105.6).
deviceLocalCapacity	integer	The Data Box Edge/Gateway device local capacity in MB.
deviceModel	string	The Data Box Edge/Gateway device model.
deviceSoftwareVersion	string	The Data Box Edge/Gateway device software version.
deviceType	string	The type of the Data Box Edge/Gateway device. "DataBoxEdgeDevice" (DataBoxEdgeDevice)
edgeProfile	object	The details of Edge Profile for this resource.
etag	string	The etag for the devices.
friendlyName	string	The Data Box Edge/Gateway device name.
identity	object	Msi identity of the resource.
kind	string	The kind of the device. Known values are: "AzureDataBoxGateway", "AzureStackEdge", "AzureStackHub", and "AzureModularDataCentre". (AzureDataBoxGateway, AzureStackEdge, AzureStackHub, AzureModularDataCentre)
kubernetesWorkloadProfile	string	Kubernetes Workload Profile.
location	string	The geo-location where the resource lives. Required.
modelDescription	string	The description of the Data Box Edge/Gateway device model.
nodeCount	integer	The number of nodes in the cluster.
resourceMoveDetails	object	The details of the move operation on this resource.
serialNumber	string	The Serial Number of Data Box Edge/Gateway device.
sku	object	The SKU type.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeZone	string	The Data Box Edge/Gateway device timezone.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
configuredRoleTypes	array	Type of compute roles configured.
culture	string	The Data Box Edge/Gateway device culture.
dataBoxEdgeDeviceStatus	string	The status of the Data Box Edge/Gateway device. Known values are: "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected", and "Maintenance". (ReadyToSetup, Online, Offline, NeedsAttention, Disconnected, PartiallyDisconnected, Maintenance)
dataResidency	object	The details of data-residency related properties for this resource.
description	string	The Description of the Data Box Edge/Gateway device.
deviceHcsVersion	string	The device software version number of the device (eg: 1.2.18105.6).
deviceLocalCapacity	integer	The Data Box Edge/Gateway device local capacity in MB.
deviceModel	string	The Data Box Edge/Gateway device model.
deviceSoftwareVersion	string	The Data Box Edge/Gateway device software version.
deviceType	string	The type of the Data Box Edge/Gateway device. "DataBoxEdgeDevice" (DataBoxEdgeDevice)
edgeProfile	object	The details of Edge Profile for this resource.
etag	string	The etag for the devices.
friendlyName	string	The Data Box Edge/Gateway device name.
identity	object	Msi identity of the resource.
kind	string	The kind of the device. Known values are: "AzureDataBoxGateway", "AzureStackEdge", "AzureStackHub", and "AzureModularDataCentre". (AzureDataBoxGateway, AzureStackEdge, AzureStackHub, AzureModularDataCentre)
kubernetesWorkloadProfile	string	Kubernetes Workload Profile.
location	string	The geo-location where the resource lives. Required.
modelDescription	string	The description of the Data Box Edge/Gateway device model.
nodeCount	integer	The number of nodes in the cluster.
resourceMoveDetails	object	The details of the move operation on this resource.
serialNumber	string	The Serial Number of Data Box Edge/Gateway device.
sku	object	The SKU type.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeZone	string	The Data Box Edge/Gateway device timezone.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	device_name, resource_group_name, subscription_id		Gets the properties of the Data Box Edge/Data Box Gateway device.
list_by_resource_group	select	resource_group_name, subscription_id	$expand	Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
list_by_subscription	select	subscription_id	$expand	Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
create_or_update	insert	device_name, resource_group_name, subscription_id, location		Creates or updates a Data Box Edge/Data Box Gateway resource.
update	update	device_name, resource_group_name, subscription_id		Modifies a Data Box Edge/Data Box Gateway resource.
create_or_update	replace	device_name, resource_group_name, subscription_id, location		Creates or updates a Data Box Edge/Data Box Gateway resource.
delete	delete	device_name, resource_group_name, subscription_id		Deletes the Data Box Edge/Data Box Gateway device.
get_network_settings	exec	device_name, resource_group_name, subscription_id		Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
get_extended_information	exec	device_name, resource_group_name, subscription_id		Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
get_update_summary	exec	device_name, resource_group_name, subscription_id		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. 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	device_name, resource_group_name, subscription_id		Downloads the updates on a Data Box Edge/Data Box Gateway device. Downloads the updates on a Data Box Edge/Data Box Gateway device.
generate_certificate	exec	device_name, resource_group_name, subscription_id		Generates certificate for activation key.
install_updates	exec	device_name, resource_group_name, subscription_id		Installs the updates on the Data Box Edge/Data Box Gateway device. Installs the updates on the Data Box Edge/Data Box Gateway device.
scan_for_updates	exec	device_name, resource_group_name, subscription_id		Scans for updates on a Data Box Edge/Data Box Gateway device.
create_or_update_security_settings	exec	device_name, resource_group_name, subscription_id, properties		Updates the security settings on a Data Box Edge/Data Box Gateway device.
update_extended_information	exec	device_name, resource_group_name, subscription_id		Gets additional information for the specified Data Box Edge/Data Box Gateway device.
upload_certificate	exec	device_name, resource_group_name, subscription_id, 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
device_name	string	The device name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
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. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
configuredRoleTypes,
culture,
dataBoxEdgeDeviceStatus,
dataResidency,
description,
deviceHcsVersion,
deviceLocalCapacity,
deviceModel,
deviceSoftwareVersion,
deviceType,
edgeProfile,
etag,
friendlyName,
identity,
kind,
kubernetesWorkloadProfile,
location,
modelDescription,
nodeCount,
resourceMoveDetails,
serialNumber,
sku,
systemData,
tags,
timeZone,
type
FROM azure.data_box_edge.devices
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
configuredRoleTypes,
culture,
dataBoxEdgeDeviceStatus,
dataResidency,
description,
deviceHcsVersion,
deviceLocalCapacity,
deviceModel,
deviceSoftwareVersion,
deviceType,
edgeProfile,
etag,
friendlyName,
identity,
kind,
kubernetesWorkloadProfile,
location,
modelDescription,
nodeCount,
resourceMoveDetails,
serialNumber,
sku,
systemData,
tags,
timeZone,
type
FROM azure.data_box_edge.devices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_subscription

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

SELECT
id,
name,
configuredRoleTypes,
culture,
dataBoxEdgeDeviceStatus,
dataResidency,
description,
deviceHcsVersion,
deviceLocalCapacity,
deviceModel,
deviceSoftwareVersion,
deviceType,
edgeProfile,
etag,
friendlyName,
identity,
kind,
kubernetesWorkloadProfile,
location,
modelDescription,
nodeCount,
resourceMoveDetails,
serialNumber,
sku,
systemData,
tags,
timeZone,
type
FROM azure.data_box_edge.devices
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
sku,
etag,
identity,
device_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ etag }}',
'{{ identity }}',
'{{ device_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: devices
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the devices resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the devices resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the 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 properties of the Data Box Edge/Gateway device.
    value:
      systemData:
        createdBy: "{{ createdBy }}"
        createdByType: "{{ createdByType }}"
        createdAt: "{{ createdAt }}"
        lastModifiedBy: "{{ lastModifiedBy }}"
        lastModifiedByType: "{{ lastModifiedByType }}"
        lastModifiedAt: "{{ lastModifiedAt }}"
      dataBoxEdgeDeviceStatus: "{{ dataBoxEdgeDeviceStatus }}"
      serialNumber: "{{ serialNumber }}"
      description: "{{ description }}"
      modelDescription: "{{ modelDescription }}"
      deviceType: "{{ deviceType }}"
      friendlyName: "{{ friendlyName }}"
      culture: "{{ culture }}"
      deviceModel: "{{ deviceModel }}"
      deviceSoftwareVersion: "{{ deviceSoftwareVersion }}"
      deviceLocalCapacity: {{ deviceLocalCapacity }}
      timeZone: "{{ timeZone }}"
      deviceHcsVersion: "{{ deviceHcsVersion }}"
      configuredRoleTypes:
        - "{{ configuredRoleTypes }}"
      nodeCount: {{ nodeCount }}
      resourceMoveDetails:
        operationInProgress: "{{ operationInProgress }}"
        operationInProgressLockTimeoutInUTC: "{{ operationInProgressLockTimeoutInUTC }}"
      edgeProfile:
        subscription:
          registrationId: "{{ registrationId }}"
          id: "{{ id }}"
          state: "{{ state }}"
          registrationDate: "{{ registrationDate }}"
          subscriptionId: "{{ subscriptionId }}"
          properties:
            tenantId: "{{ tenantId }}"
            locationPlacementId: "{{ locationPlacementId }}"
            quotaId: "{{ quotaId }}"
            serializedDetails: "{{ serializedDetails }}"
            registeredFeatures:
              - name: "{{ name }}"
                state: "{{ state }}"
      dataResidency:
        type: "{{ type }}"
      kubernetesWorkloadProfile: "{{ kubernetesWorkloadProfile }}"
  - name: sku
    description: |
      The SKU type.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      The etag for the devices.
  - name: identity
    description: |
      Msi identity of the resource.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"

UPDATE examples

update

Modifies a Data Box Edge/Data Box Gateway resource.

UPDATE azure.data_box_edge.devices
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
device_name = '{{ device_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.data_box_edge.devices
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
etag = '{{ etag }}',
identity = '{{ identity }}'
WHERE 
device_name = '{{ device_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --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 device_name = '{{ device_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_network_settings

Gets the network settings of the specified Data Box Edge/Data Box Gateway device.

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

get_extended_information

Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.

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

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. 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.data_box_edge.devices.get_update_summary 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

download_updates

Downloads the updates on a Data Box Edge/Data Box Gateway device. Downloads the updates on a Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.devices.download_updates 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

generate_certificate

Generates certificate for activation key.

EXEC azure.data_box_edge.devices.generate_certificate 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

install_updates

Installs the updates on the Data Box Edge/Data Box Gateway device. Installs the updates on the Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.devices.install_updates 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

scan_for_updates

Scans for updates on a Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.devices.scan_for_updates 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_security_settings

Updates the security settings on a Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.devices.create_or_update_security_settings 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_extended_information

Gets additional information for the specified Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.devices.update_extended_information 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"clientSecretStoreId": "{{ clientSecretStoreId }}", 
"clientSecretStoreUrl": "{{ clientSecretStoreUrl }}", 
"channelIntegrityKeyName": "{{ channelIntegrityKeyName }}", 
"channelIntegrityKeyVersion": "{{ channelIntegrityKeyVersion }}", 
"syncStatus": "{{ syncStatus }}"
}'
;

upload_certificate

Uploads registration certificate for the device.

EXEC azure.data_box_edge.devices.upload_certificate 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;