devices

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

Overview

Name	devices
Type	Resource
Id	azure_extras.storsimple_1200_series.devices

Fields

The following fields are returned by SELECT queries:

get

The device.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	Collection of properties for the device
type	string	The type.

list_by_manager

The collection of devices.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	Collection of properties for the device
type	string	The type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, subscriptionId, resourceGroupName, managerName	$expand	Returns the properties of the specified device name.
list_by_manager	select	subscriptionId, resourceGroupName, managerName	$expand	Retrieves all the devices in a manager.
patch	update	deviceName, subscriptionId, resourceGroupName, managerName		Patches the device.
delete	delete	deviceName, subscriptionId, resourceGroupName, managerName		Deletes the device.
deactivate	exec	deviceName, subscriptionId, resourceGroupName, managerName		Deactivates the device.
download_updates	exec	deviceName, subscriptionId, resourceGroupName, managerName		Downloads updates on the device.
failover	exec	deviceName, subscriptionId, resourceGroupName, managerName		Fails over the device to another device.
install_updates	exec	deviceName, subscriptionId, resourceGroupName, managerName		Installs the updates on the device.
scan_for_updates	exec	deviceName, subscriptionId, resourceGroupName, managerName		Scans for updates on 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.
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id
$expand	string	Specify $expand=details to populate additional fields related to the device.

SELECT examples

get

Returns the properties of the specified device name.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.devices
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_manager

Retrieves all the devices in a manager.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.devices
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
AND $expand = '{{ $expand }}'
;

UPDATE examples

patch

Patches the device.

UPDATE azure_extras.storsimple_1200_series.devices
SET 
data__deviceDescription = '{{ deviceDescription }}'
WHERE 
deviceName = '{{ deviceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the device.

DELETE FROM azure_extras.storsimple_1200_series.devices
WHERE deviceName = '{{ deviceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;

Lifecycle Methods

deactivate

Deactivates the device.

EXEC azure_extras.storsimple_1200_series.devices.deactivate 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;

download_updates

Downloads updates on the device.

EXEC azure_extras.storsimple_1200_series.devices.download_updates 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;

failover

Fails over the device to another device.

EXEC azure_extras.storsimple_1200_series.devices.failover 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required 
@@json=
'{
"accesspointIds": "{{ accesspointIds }}", 
"targetDeviceId": "{{ targetDeviceId }}", 
"skipValidation": {{ skipValidation }}, 
"keepSourceDevice": {{ keepSourceDevice }}
}'
;

install_updates

Installs the updates on the device.

EXEC azure_extras.storsimple_1200_series.devices.install_updates 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;

scan_for_updates

Scans for updates on the device.

EXEC azure_extras.storsimple_1200_series.devices.scan_for_updates 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;