containers

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

Overview

Name	containers
Type	Resource
Id	azure.data_box_edge.containers

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.
containerStatus	string	Current status of the container. Known values are: "OK", "Offline", "Unknown", "Updating", and "NeedsAttention". (OK, Offline, Unknown, Updating, NeedsAttention)
createdDateTime	string (date-time)	The UTC time when container got created.
dataFormat	string	DataFormat for Container. Required. Known values are: "BlockBlob", "PageBlob", and "AzureFile". (BlockBlob, PageBlob, AzureFile)
refreshDetails	object	Details of the refresh job on this container.
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_storage_account

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.
containerStatus	string	Current status of the container. Known values are: "OK", "Offline", "Unknown", "Updating", and "NeedsAttention". (OK, Offline, Unknown, Updating, NeedsAttention)
createdDateTime	string (date-time)	The UTC time when container got created.
dataFormat	string	DataFormat for Container. Required. Known values are: "BlockBlob", "PageBlob", and "AzureFile". (BlockBlob, PageBlob, AzureFile)
refreshDetails	object	Details of the refresh job on this container.
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, container_name, resource_group_name, subscription_id		Gets a container by name. Gets a container by name.
list_by_storage_account	select	device_name, storage_account_name, resource_group_name, subscription_id		Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device. Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.
create_or_update	insert	device_name, storage_account_name, container_name, resource_group_name, subscription_id, properties		Creates a new container or updates an existing container on the device. Creates a new container or updates an existing container on the device.
create_or_update	replace	device_name, storage_account_name, container_name, resource_group_name, subscription_id, properties		Creates a new container or updates an existing container on the device. Creates a new container or updates an existing container on the device.
delete	delete	device_name, storage_account_name, container_name, resource_group_name, subscription_id		Deletes the container on the Data Box Edge/Data Box Gateway device.
refresh	exec	device_name, storage_account_name, container_name, resource_group_name, subscription_id		Refreshes the container metadata with the data from the cloud. Refreshes the container metadata with the data from the cloud.

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
container_name	string	The container Name. Required.
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 container by name. Gets a container by name.

SELECT
id,
name,
containerStatus,
createdDateTime,
dataFormat,
refreshDetails,
systemData,
type
FROM azure.data_box_edge.containers
WHERE device_name = '{{ device_name }}' -- required
AND storage_account_name = '{{ storage_account_name }}' -- required
AND container_name = '{{ container_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_storage_account

Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device. Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
containerStatus,
createdDateTime,
dataFormat,
refreshDetails,
systemData,
type
FROM azure.data_box_edge.containers
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
;

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: containers
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the containers resource.
  - name: storage_account_name
    value: "{{ storage_account_name }}"
    description: Required parameter for the containers resource.
  - name: container_name
    value: "{{ container_name }}"
    description: Required parameter for the containers resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the containers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the containers resource.
  - name: properties
    description: |
      The container properties. Required.
    value:
      containerStatus: "{{ containerStatus }}"
      dataFormat: "{{ dataFormat }}"
      refreshDetails:
        inProgressRefreshJobId: "{{ inProgressRefreshJobId }}"
        lastCompletedRefreshJobTimeInUTC: "{{ lastCompletedRefreshJobTimeInUTC }}"
        errorManifestFile: "{{ errorManifestFile }}"
        lastJob: "{{ lastJob }}"
      createdDateTime: "{{ createdDateTime }}"

REPLACE examples

create_or_update

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

REPLACE azure.data_box_edge.containers
SET 
properties = '{{ properties }}'
WHERE 
device_name = '{{ device_name }}' --required
AND storage_account_name = '{{ storage_account_name }}' --required
AND container_name = '{{ container_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 container on the Data Box Edge/Data Box Gateway device.

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

Lifecycle Methods

refresh

Refreshes the container metadata with the data from the cloud. Refreshes the container metadata with the data from the cloud.

EXEC azure.data_box_edge.containers.refresh 
@device_name='{{ device_name }}' --required, 
@storage_account_name='{{ storage_account_name }}' --required, 
@container_name='{{ container_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;