shares

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

Overview

Name	shares
Type	Resource
Id	azure.data_box_edge.shares

Fields

vw_shares

Name	Datatype	Description
id	text	The path ID that uniquely identifies the object.
name	text	The object name.
description	text	field from the properties object
access_protocol	text	field from the properties object
azure_container_info	text	field from the properties object
client_access_rights	text	field from the properties object
data_policy	text	field from the properties object
deviceName	text	field from the properties object
monitoring_status	text	field from the properties object
refresh_details	text	field from the properties object
resourceGroupName	text	field from the properties object
share_mappings	text	field from the properties object
share_status	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.
user_access_rights	text	field from the properties object

shares

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The share 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	deviceName, name, resourceGroupName, subscriptionId
list_by_data_box_edge_device	SELECT	deviceName, resourceGroupName, subscriptionId
create_or_update	INSERT	deviceName, name, resourceGroupName, subscriptionId, data__properties
delete	DELETE	deviceName, name, resourceGroupName, subscriptionId	Deletes the share on the Data Box Edge/Data Box Gateway device.
refresh	EXEC	deviceName, name, resourceGroupName, subscriptionId

SELECT examples

vw_shares

SELECT
id,
name,
description,
access_protocol,
azure_container_info,
client_access_rights,
data_policy,
deviceName,
monitoring_status,
refresh_details,
resourceGroupName,
share_mappings,
share_status,
subscriptionId,
system_data,
type,
user_access_rights
FROM azure.data_box_edge.vw_shares
WHERE deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

shares

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_box_edge.shares (
deviceName,
name,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ deviceName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ 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: description
          value: string
        - name: shareStatus
          value: string
        - name: monitoringStatus
          value: string
        - name: azureContainerInfo
          value:
            - name: storageAccountCredentialId
              value: string
            - name: containerName
              value: string
            - name: dataFormat
              value: string
        - name: accessProtocol
          value: string
        - name: userAccessRights
          value:
            - - name: userId
                value: string
              - name: accessType
                value: string
        - name: clientAccessRights
          value:
            - - name: client
                value: string
              - name: accessPermission
                value: string
        - name: refreshDetails
          value:
            - name: inProgressRefreshJobId
              value: string
            - name: lastCompletedRefreshJobTimeInUTC
              value: string
            - name: errorManifestFile
              value: string
            - name: lastJob
              value: string
        - name: shareMappings
          value:
            - - name: shareId
                value: string
              - name: roleId
                value: string
              - name: mountPoint
                value: string
              - name: mountType
                value: string
              - name: roleType
                value: string
        - name: dataPolicy
          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 shares resource.

/*+ delete */
DELETE FROM azure.data_box_edge.shares
WHERE deviceName = '{{ deviceName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';