iscsi_disks

Creates, updates, deletes, gets or lists an iscsi_disks resource.

Overview

Name	iscsi_disks
Type	Resource
Id	azure_extras.storsimple_1200_series.iscsi_disks

Fields

The following fields are returned by SELECT queries:

get

The iSCSI disk.

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

list_by_iscsi_server

The collection of iSCSI disks.

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 iSCSI disks.

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, iscsiServerName, diskName, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified iSCSI disk name.
list_by_iscsi_server	select	deviceName, iscsiServerName, subscriptionId, resourceGroupName, managerName		Retrieves all the disks in a iSCSI server.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName		Retrieves all the iSCSI disks in a device.
create_or_update	insert	deviceName, iscsiServerName, diskName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the iSCSI disk.
delete	delete	deviceName, iscsiServerName, diskName, subscriptionId, resourceGroupName, managerName		Deletes the iSCSI disk.

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.
diskName	string	The disk name.
iscsiServerName	string	The iSCSI 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 iSCSI disk name.

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

list_by_iscsi_server

Retrieves all the disks in a iSCSI server.

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

list_by_device

Retrieves all the iSCSI disks in a device.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.iscsi_disks
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 iSCSI disk.

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

Manifest

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

DELETE examples

delete

Deletes the iSCSI disk.

DELETE FROM azure_extras.storsimple_1200_series.iscsi_disks
WHERE deviceName = '{{ deviceName }}' --required
AND iscsiServerName = '{{ iscsiServerName }}' --required
AND diskName = '{{ diskName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;