devices_extended_information
Creates, updates, deletes, gets or lists a devices_extended_information resource.
Overview
| Name | devices_extended_information |
| Type | Resource |
| Id | azure.data_box_edge.devices_extended_information |
Fields
The following fields are returned by SELECT queries:
- get
The additional information.
| Name | Datatype | Description |
|---|---|---|
id | string | The path ID that uniquely identifies the object. |
name | string | The object name. |
properties | object | The extended info properties. |
systemData | object | Metadata pertaining to creation and last modification of DataBoxEdgeDevice |
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 additional information for the specified Azure Stack Edge/Data Box Gateway device. | |
update | exec | deviceName, subscriptionId, resourceGroupName | Gets additional information for the specified Data Box Edge/Data Box Gateway 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. |
SELECT examples
- get
Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.devices_extended_information
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;
Lifecycle Methods
- update
Gets additional information for the specified Data Box Edge/Data Box Gateway device.
EXEC azure.data_box_edge.devices_extended_information.update
@deviceName='{{ deviceName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required
@@json=
'{
"clientSecretStoreId": "{{ clientSecretStoreId }}",
"clientSecretStoreUrl": "{{ clientSecretStoreUrl }}",
"channelIntegrityKeyName": "{{ channelIntegrityKeyName }}",
"channelIntegrityKeyVersion": "{{ channelIntegrityKeyVersion }}",
"syncStatus": "{{ syncStatus }}"
}'
;