shares

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

Overview

Name	shares
Type	Resource
Id	azure.data_box_edge.shares

Fields

The following fields are returned by SELECT queries:

get

The share details.

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

list_by_data_box_edge_device

The collection of all the shares on the device.

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 Share
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, name, subscriptionId, resourceGroupName
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName
create_or_update	insert	deviceName, name, subscriptionId, resourceGroupName, data__properties
delete	delete	deviceName, name, subscriptionId, resourceGroupName		Deletes the share on the Data Box Edge/Data Box Gateway device.
refresh	exec	deviceName, name, 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
deviceName	string	The device name.
name	string	The share name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.

SELECT examples

get

The share details.

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

list_by_data_box_edge_device

The collection of all the shares on the device.

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

INSERT examples

create_or_update

No description available.

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

Manifest

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

DELETE examples

delete

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

DELETE FROM azure.data_box_edge.shares
WHERE deviceName = '{{ deviceName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;

Lifecycle Methods

refresh

Successfully refreshed the share on the device.

EXEC azure.data_box_edge.shares.refresh 
@deviceName='{{ deviceName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required
;