containers

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

Overview

Name	containers
Type	Resource
Id	azure.data_box_edge.containers

Fields

vw_containers

Name	Datatype	Description
id	text	The path ID that uniquely identifies the object.
name	text	The object name.
containerName	text	field from the properties object
container_status	text	field from the properties object
created_date_time	text	field from the properties object
data_format	text	field from the properties object
deviceName	text	field from the properties object
refresh_details	text	field from the properties object
resourceGroupName	text	field from the properties object
storageAccountName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The hierarchical type of the object.

containers

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 the resource.
type	string	The hierarchical type of the object.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	containerName, deviceName, resourceGroupName, storageAccountName, subscriptionId
list_by_storage_account	SELECT	deviceName, resourceGroupName, storageAccountName, subscriptionId
create_or_update	INSERT	containerName, deviceName, resourceGroupName, storageAccountName, subscriptionId, data__properties
delete	DELETE	containerName, deviceName, resourceGroupName, storageAccountName, subscriptionId	Deletes the container on the Data Box Edge/Data Box Gateway device.
refresh	EXEC	containerName, deviceName, resourceGroupName, storageAccountName, subscriptionId

SELECT examples

vw_containers

SELECT
id,
name,
containerName,
container_status,
created_date_time,
data_format,
deviceName,
refresh_details,
resourceGroupName,
storageAccountName,
subscriptionId,
system_data,
type
FROM azure.data_box_edge.vw_containers
WHERE deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND storageAccountName = '{{ storageAccountName }}'
AND subscriptionId = '{{ subscriptionId }}';

containers

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

INSERT example

Use the following StackQL query and manifest file to create a new containers resource.

All Properties

/*+ create */
INSERT INTO azure.data_box_edge.containers (
containerName,
deviceName,
resourceGroupName,
storageAccountName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ containerName }}',
'{{ deviceName }}',
'{{ resourceGroupName }}',
'{{ storageAccountName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: containerStatus
          value: string
        - name: dataFormat
          value: string
        - name: refreshDetails
          value:
            - name: inProgressRefreshJobId
              value: string
            - name: lastCompletedRefreshJobTimeInUTC
              value: string
            - name: errorManifestFile
              value: string
            - name: lastJob
              value: string
        - name: createdDateTime
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

DELETE example

Deletes the specified containers resource.

/*+ delete */
DELETE FROM azure.data_box_edge.containers
WHERE containerName = '{{ containerName }}'
AND deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND storageAccountName = '{{ storageAccountName }}'
AND subscriptionId = '{{ subscriptionId }}';