file_shares

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

Overview

Name	file_shares
Type	Resource
Id	azure_extras.storsimple_1200_series.file_shares

Fields

vw_file_shares

Name	Datatype	Description
id	text	The identifier.
name	text	The name.
description	text	field from the properties object
admin_user	text	field from the properties object
data_policy	text	field from the properties object
deviceName	text	field from the properties object
fileServerName	text	field from the properties object
local_used_capacity_in_bytes	text	field from the properties object
managerName	text	field from the properties object
monitoring_status	text	field from the properties object
provisioned_capacity_in_bytes	text	field from the properties object
resourceGroupName	text	field from the properties object
shareName	text	field from the properties object
share_status	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type.
used_capacity_in_bytes	text	field from the properties object

file_shares

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	The File Share.
type	string	The type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	deviceName, fileServerName, managerName, resourceGroupName, shareName, subscriptionId	Returns the properties of the specified file share name.
list_by_device	SELECT	deviceName, managerName, resourceGroupName, subscriptionId	Retrieves all the file shares in a device.
list_by_file_server	SELECT	deviceName, fileServerName, managerName, resourceGroupName, subscriptionId	Retrieves all the file shares in a file server.
create_or_update	INSERT	deviceName, fileServerName, managerName, resourceGroupName, shareName, subscriptionId, data__properties	Creates or updates the file share.
delete	DELETE	deviceName, fileServerName, managerName, resourceGroupName, shareName, subscriptionId	Deletes the file share.

SELECT examples

Retrieves all the file shares in a device.

vw_file_shares

SELECT
id,
name,
description,
admin_user,
data_policy,
deviceName,
fileServerName,
local_used_capacity_in_bytes,
managerName,
monitoring_status,
provisioned_capacity_in_bytes,
resourceGroupName,
shareName,
share_status,
subscriptionId,
type,
used_capacity_in_bytes
FROM azure_extras.storsimple_1200_series.vw_file_shares
WHERE deviceName = '{{ deviceName }}'
AND managerName = '{{ managerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

file_shares

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.file_shares
WHERE deviceName = '{{ deviceName }}'
AND managerName = '{{ managerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure_extras.storsimple_1200_series.file_shares (
deviceName,
fileServerName,
managerName,
resourceGroupName,
shareName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ deviceName }}',
'{{ fileServerName }}',
'{{ managerName }}',
'{{ resourceGroupName }}',
'{{ shareName }}',
'{{ 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: dataPolicy
          value: string
        - name: adminUser
          value: string
        - name: provisionedCapacityInBytes
          value: integer
        - name: usedCapacityInBytes
          value: integer
        - name: localUsedCapacityInBytes
          value: integer
        - name: monitoringStatus
          value: string

DELETE example

Deletes the specified file_shares resource.

/*+ delete */
DELETE FROM azure_extras.storsimple_1200_series.file_shares
WHERE deviceName = '{{ deviceName }}'
AND fileServerName = '{{ fileServerName }}'
AND managerName = '{{ managerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND shareName = '{{ shareName }}'
AND subscriptionId = '{{ subscriptionId }}';