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

The container details.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The container properties.
systemData	object	Metadata pertaining to creation and last modification of Container
type	string	The hierarchical type of the object.

list_by_storage_account

The collection of all the containers on the device.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The container properties.
systemData	object	Metadata pertaining to creation and last modification of Container
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, containerName, subscriptionId, resourceGroupName
list_by_storage_account	select	deviceName, storageAccountName, subscriptionId, resourceGroupName
create_or_update	insert	deviceName, storageAccountName, containerName, subscriptionId, resourceGroupName, data__properties
delete	delete	deviceName, storageAccountName, containerName, subscriptionId, resourceGroupName		Deletes the container on the Data Box Edge/Data Box Gateway device.
refresh	exec	deviceName, storageAccountName, containerName, subscriptionId, resourceGroupName

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
containerName	string	The container name.
deviceName	string	The device name.
resourceGroupName	string	The resource group name.
storageAccountName	string	The Storage Account Name
subscriptionId	string	The subscription ID.

SELECT examples

get

The container details.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.containers
WHERE deviceName = '{{ deviceName }}' -- required
AND storageAccountName = '{{ storageAccountName }}' -- required
AND containerName = '{{ containerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_storage_account

The collection of all the containers on the device.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.containers
WHERE deviceName = '{{ deviceName }}' -- required
AND storageAccountName = '{{ storageAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.data_box_edge.containers (
data__properties,
deviceName,
storageAccountName,
containerName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ storageAccountName }}',
'{{ containerName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: containers
  props:
    - name: deviceName
      value: string
      description: Required parameter for the containers resource.
    - name: storageAccountName
      value: string
      description: Required parameter for the containers resource.
    - name: containerName
      value: string
      description: Required parameter for the containers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the containers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the containers resource.
    - name: properties
      value: object
      description: |
        The container properties.

DELETE examples

delete

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

DELETE FROM azure.data_box_edge.containers
WHERE deviceName = '{{ deviceName }}' --required
AND storageAccountName = '{{ storageAccountName }}' --required
AND containerName = '{{ containerName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;

Lifecycle Methods

refresh

Successfully refreshed the container on the device.

EXEC azure.data_box_edge.containers.refresh 
@deviceName='{{ deviceName }}' --required, 
@storageAccountName='{{ storageAccountName }}' --required, 
@containerName='{{ containerName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;