iscsi_targets

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

Overview

Name	iscsi_targets
Type	Resource
Id	azure.storage_pool.iscsi_targets

Fields

The following fields are returned by SELECT queries:

get

Operation completed successfully; retrieved iSCSI Target.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
managedByExtended	array	List of Azure resource ids that manage this resource.
properties	object	Properties for iSCSI Target operations.
systemData	object	Resource metadata required by ARM RPC

list_by_disk_pool

Operation completed successfully; retrieved iSCSI Targets in a Disk pool.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
managedByExtended	array	List of Azure resource ids that manage this resource.
properties	object	Properties for iSCSI Target operations.
systemData	object	Resource metadata required by ARM RPC

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, diskPoolName, iscsiTargetName		Get an iSCSI Target.
list_by_disk_pool	select	subscriptionId, resourceGroupName, diskPoolName		Get iSCSI Targets in a Disk pool.
create_or_update	insert	subscriptionId, resourceGroupName, diskPoolName, iscsiTargetName, data__properties		Create or Update an iSCSI Target.
update	update	subscriptionId, resourceGroupName, diskPoolName, iscsiTargetName, data__properties		Update an iSCSI Target.
delete	delete	subscriptionId, resourceGroupName, diskPoolName, iscsiTargetName		Delete an iSCSI Target.

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
diskPoolName	string	The name of the Disk Pool.
iscsiTargetName	string	The name of the iSCSI Target.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get an iSCSI Target.

SELECT
managedBy,
managedByExtended,
properties,
systemData
FROM azure.storage_pool.iscsi_targets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND diskPoolName = '{{ diskPoolName }}' -- required
AND iscsiTargetName = '{{ iscsiTargetName }}' -- required
;

list_by_disk_pool

Get iSCSI Targets in a Disk pool.

SELECT
managedBy,
managedByExtended,
properties,
systemData
FROM azure.storage_pool.iscsi_targets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND diskPoolName = '{{ diskPoolName }}' -- required
;

INSERT examples

create_or_update

Create or Update an iSCSI Target.

INSERT INTO azure.storage_pool.iscsi_targets (
data__properties,
data__managedBy,
data__managedByExtended,
subscriptionId,
resourceGroupName,
diskPoolName,
iscsiTargetName
)
SELECT 
'{{ properties }}' /* required */,
'{{ managedBy }}',
'{{ managedByExtended }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ diskPoolName }}',
'{{ iscsiTargetName }}'
RETURNING
managedBy,
managedByExtended,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: iscsi_targets
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the iscsi_targets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the iscsi_targets resource.
    - name: diskPoolName
      value: string
      description: Required parameter for the iscsi_targets resource.
    - name: iscsiTargetName
      value: string
      description: Required parameter for the iscsi_targets resource.
    - name: properties
      value: object
      description: |
        Properties for iSCSI Target create request.
    - name: managedBy
      value: string
      description: |
        Azure resource id. Indicates if this resource is managed by another Azure resource.
    - name: managedByExtended
      value: array
      description: |
        List of Azure resource ids that manage this resource.

UPDATE examples

update

Update an iSCSI Target.

UPDATE azure.storage_pool.iscsi_targets
SET 
data__properties = '{{ properties }}',
data__managedBy = '{{ managedBy }}',
data__managedByExtended = '{{ managedByExtended }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskPoolName = '{{ diskPoolName }}' --required
AND iscsiTargetName = '{{ iscsiTargetName }}' --required
AND data__properties = '{{ properties }}' --required
RETURNING
managedBy,
managedByExtended,
properties,
systemData;

DELETE examples

delete

Delete an iSCSI Target.

DELETE FROM azure.storage_pool.iscsi_targets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskPoolName = '{{ diskPoolName }}' --required
AND iscsiTargetName = '{{ iscsiTargetName }}' --required
;