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

The following fields are returned by SELECT queries:

get

The file share.

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

list_by_file_server

The collection of file shares.

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

list_by_device

The collection of file shares.

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

Methods

The following methods are available for this resource:

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

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.
fileServerName	string	The file server name.
managerName	string	The manager name
resourceGroupName	string	The resource group name
shareName	string	The file share Name
subscriptionId	string	The subscription id

SELECT examples

get

Returns the properties of the specified file share name.

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

list_by_file_server

Retrieves all the file shares in a file server.

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

list_by_device

Retrieves all the file shares in a device.

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

INSERT examples

create_or_update

Creates or updates the file share.

INSERT INTO azure_extras.storsimple_1200_series.file_shares (
data__properties,
deviceName,
fileServerName,
shareName,
subscriptionId,
resourceGroupName,
managerName
)
SELECT 
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ fileServerName }}',
'{{ shareName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managerName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

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

DELETE examples

delete

Deletes the file share.

DELETE FROM azure_extras.storsimple_1200_series.file_shares
WHERE deviceName = '{{ deviceName }}' --required
AND fileServerName = '{{ fileServerName }}' --required
AND shareName = '{{ shareName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;