storage_accounts
Creates, updates, deletes, gets or lists a storage_accounts resource.
Overview
| Name | storage_accounts |
| Type | Resource |
| Id | azure.data_box_edge.storage_accounts |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_data_box_edge_device
The storage account details.
| Name | Datatype | Description |
|---|---|---|
id | string | The path ID that uniquely identifies the object. |
name | string | The object name. |
properties | object | The Storage Account properties. |
systemData | object | Metadata pertaining to creation and last modification of StorageAccount |
type | string | The hierarchical type of the object. |
The collection of all the StorageAccounts on the device.
| Name | Datatype | Description |
|---|---|---|
id | string | The path ID that uniquely identifies the object. |
name | string | The object name. |
properties | object | The Storage Account properties. |
systemData | object | Metadata pertaining to creation and last modification of StorageAccount |
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, storageAccountName, subscriptionId, resourceGroupName | ||
list_by_data_box_edge_device | select | deviceName, subscriptionId, resourceGroupName | ||
create_or_update | insert | deviceName, storageAccountName, subscriptionId, resourceGroupName, data__properties | ||
delete | delete | deviceName, storageAccountName, subscriptionId, resourceGroupName | Deletes the StorageAccount on the 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. |
storageAccountName | string | The StorageAccount name. |
subscriptionId | string | The subscription ID. |
SELECT examples
- get
- list_by_data_box_edge_device
The storage account details.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.storage_accounts
WHERE deviceName = '{{ deviceName }}' -- required
AND storageAccountName = '{{ storageAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;
The collection of all the StorageAccounts on the device.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.storage_accounts
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;
INSERT examples
- create_or_update
- Manifest
No description available.
INSERT INTO azure.data_box_edge.storage_accounts (
data__properties,
deviceName,
storageAccountName,
subscriptionId,
resourceGroupName
)
SELECT
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ storageAccountName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
properties,
systemData,
type
;
# Description fields are for documentation purposes
- name: storage_accounts
props:
- name: deviceName
value: string
description: Required parameter for the storage_accounts resource.
- name: storageAccountName
value: string
description: Required parameter for the storage_accounts resource.
- name: subscriptionId
value: string
description: Required parameter for the storage_accounts resource.
- name: resourceGroupName
value: string
description: Required parameter for the storage_accounts resource.
- name: properties
value: object
description: |
The Storage Account properties.
DELETE examples
- delete
Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.
DELETE FROM azure.data_box_edge.storage_accounts
WHERE deviceName = '{{ deviceName }}' --required
AND storageAccountName = '{{ storageAccountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;