file_servers

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

Overview

Name	file_servers
Type	Resource
Id	azure_extras.storsimple_1200_series.file_servers

Fields

The following fields are returned by SELECT queries:

get

The file server.

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 servers.

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

list_by_manager

The collection of file servers.

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, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified file server name.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName		Retrieves all the file servers in a device.
list_by_manager	select	subscriptionId, resourceGroupName, managerName		Retrieves all the file servers in a manager.
create_or_update	insert	deviceName, fileServerName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the file server.
delete	delete	deviceName, fileServerName, subscriptionId, resourceGroupName, managerName		Deletes the file server.
backup_now	exec	deviceName, fileServerName, subscriptionId, resourceGroupName, managerName		Backup the file server now.

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
subscriptionId	string	The subscription id

SELECT examples

get

Returns the properties of the specified file server name.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.file_servers
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 servers in a device.

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

list_by_manager

Retrieves all the file servers in a manager.

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

INSERT examples

create_or_update

Creates or updates the file server.

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

Manifest

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

DELETE examples

delete

Deletes the file server.

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

Lifecycle Methods

backup_now

Backup the file server now.

EXEC azure_extras.storsimple_1200_series.file_servers.backup_now 
@deviceName='{{ deviceName }}' --required, 
@fileServerName='{{ fileServerName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;