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

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.
blobEndpoint	string	BlobEndpoint of Storage Account.
containerCount	integer	The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.
dataPolicy	string	Data policy of the storage Account. Required. Known values are: "Cloud" and "Local". (Cloud, Local)
description	string	Description for the storage Account.
storageAccountCredentialId	string	Storage Account Credential Id.
storageAccountStatus	string	Current status of the storage account. Known values are: "OK", "Offline", "Unknown", "Updating", and "NeedsAttention". (OK, Offline, Unknown, Updating, NeedsAttention)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_data_box_edge_device

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.
blobEndpoint	string	BlobEndpoint of Storage Account.
containerCount	integer	The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.
dataPolicy	string	Data policy of the storage Account. Required. Known values are: "Cloud" and "Local". (Cloud, Local)
description	string	Description for the storage Account.
storageAccountCredentialId	string	Storage Account Credential Id.
storageAccountStatus	string	Current status of the storage account. Known values are: "OK", "Offline", "Unknown", "Updating", and "NeedsAttention". (OK, Offline, Unknown, Updating, NeedsAttention)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, storage_account_name, resource_group_name, subscription_id		Gets a StorageAccount by name. Gets a StorageAccount by name.
list_by_data_box_edge_device	select	device_name, resource_group_name, subscription_id		Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device. Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.
create_or_update	insert	device_name, storage_account_name, resource_group_name, subscription_id, properties		Creates a new StorageAccount or updates an existing StorageAccount on the device. Creates a new StorageAccount or updates an existing StorageAccount on the device.
create_or_update	replace	device_name, storage_account_name, resource_group_name, subscription_id, properties		Creates a new StorageAccount or updates an existing StorageAccount on the device. Creates a new StorageAccount or updates an existing StorageAccount on the device.
delete	delete	device_name, storage_account_name, resource_group_name, subscription_id		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
device_name	string	The device name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_account_name	string	The storage account name. Required.
subscription_id	string

SELECT examples

get

Gets a StorageAccount by name. Gets a StorageAccount by name.

SELECT
id,
name,
blobEndpoint,
containerCount,
dataPolicy,
description,
storageAccountCredentialId,
storageAccountStatus,
systemData,
type
FROM azure.data_box_edge.storage_accounts
WHERE device_name = '{{ device_name }}' -- required
AND storage_account_name = '{{ storage_account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_data_box_edge_device

Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device. Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
blobEndpoint,
containerCount,
dataPolicy,
description,
storageAccountCredentialId,
storageAccountStatus,
systemData,
type
FROM azure.data_box_edge.storage_accounts
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new StorageAccount or updates an existing StorageAccount on the device. Creates a new StorageAccount or updates an existing StorageAccount on the device.

INSERT INTO azure.data_box_edge.storage_accounts (
properties,
device_name,
storage_account_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ device_name }}',
'{{ storage_account_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_accounts
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the storage_accounts resource.
  - name: storage_account_name
    value: "{{ storage_account_name }}"
    description: Required parameter for the storage_accounts resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_accounts resource.
  - name: properties
    description: |
      The Storage Account properties. Required.
    value:
      description: "{{ description }}"
      storageAccountStatus: "{{ storageAccountStatus }}"
      dataPolicy: "{{ dataPolicy }}"
      storageAccountCredentialId: "{{ storageAccountCredentialId }}"
      blobEndpoint: "{{ blobEndpoint }}"
      containerCount: {{ containerCount }}

REPLACE examples

create_or_update

Creates a new StorageAccount or updates an existing StorageAccount on the device. Creates a new StorageAccount or updates an existing StorageAccount on the device.

REPLACE azure.data_box_edge.storage_accounts
SET 
properties = '{{ properties }}'
WHERE 
device_name = '{{ device_name }}' --required
AND storage_account_name = '{{ storage_account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.

DELETE FROM azure.data_box_edge.storage_accounts
WHERE device_name = '{{ device_name }}' --required
AND storage_account_name = '{{ storage_account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;