devices

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

Overview

Name	devices
Type	Resource
Id	azure_extras.storsimple_8000_series.devices

Fields

The following fields are returned by SELECT queries:

get

The device.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the StorSimple device.
type	string	The hierarchical type of the object.

list_by_manager

The collection of devices.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the StorSimple device.
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, managerName	$expand	Returns the properties of the specified device.
list_by_manager	select	subscriptionId, resourceGroupName, managerName	$expand	Returns the list of devices for the specified manager.
update	update	deviceName, subscriptionId, resourceGroupName, managerName, data__properties		Patches the device.
delete	delete	deviceName, subscriptionId, resourceGroupName, managerName		Deletes the device.
configure	exec	subscriptionId, resourceGroupName, managerName, properties		Complete minimal setup before using the device.
authorize_for_service_encryption_key_rollover	exec	deviceName, subscriptionId, resourceGroupName, managerName		Authorizes the specified device for service data encryption key rollover.
deactivate	exec	deviceName, subscriptionId, resourceGroupName, managerName		Deactivates the device.
install_updates	exec	deviceName, subscriptionId, resourceGroupName, managerName		Downloads and installs the updates on the device.
scan_for_updates	exec	deviceName, subscriptionId, resourceGroupName, managerName		Scans for updates on the device.
failover	exec	sourceDeviceName, subscriptionId, resourceGroupName, managerName		Failovers a set of volume containers from a specified source device to a target 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
sourceDeviceName	string	The source device name on which failover is performed.
subscriptionId	string	The subscription id
$expand	string	Specify $expand=details to populate additional fields related to the device or $expand=rolloverdetails to populate additional fields related to the service data encryption key rollover on device

SELECT examples

get

Returns the properties of the specified device.

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

list_by_manager

Returns the list of devices for the specified manager.

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

UPDATE examples

update

Patches the device.

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

DELETE examples

delete

Deletes the device.

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

Lifecycle Methods

configure

Complete minimal setup before using the device.

EXEC azure_extras.storsimple_8000_series.devices.configure 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

authorize_for_service_encryption_key_rollover

Authorizes the specified device for service data encryption key rollover.

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

deactivate

Deactivates the device.

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

install_updates

Downloads and installs the updates on the device.

EXEC azure_extras.storsimple_8000_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_8000_series.devices.scan_for_updates 
@deviceName='{{ deviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;

failover

Failovers a set of volume containers from a specified source device to a target device.

EXEC azure_extras.storsimple_8000_series.devices.failover 
@sourceDeviceName='{{ sourceDeviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required 
@@json=
'{
"targetDeviceId": "{{ targetDeviceId }}", 
"volumeContainers": "{{ volumeContainers }}"
}'
;