iscsi_paths

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

Overview

Name	iscsi_paths
Type	Resource
Id	azure_isv.avs.iscsi_paths

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
networkBlock	string	CIDR Block for iSCSI path. Required.
provisioningState	string	The state of the iSCSI path provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Building", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Pending, Building, Deleting, Updating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_cloud_name, subscription_id		Get a IscsiPath.
create_or_update	insert	resource_group_name, private_cloud_name, subscription_id		Create a IscsiPath.
create_or_update	replace	resource_group_name, private_cloud_name, subscription_id		Create a IscsiPath.
delete	delete	resource_group_name, private_cloud_name, subscription_id		Delete a IscsiPath.
list_by_private_cloud	exec	resource_group_name, private_cloud_name, subscription_id		List IscsiPath resources by PrivateCloud.

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
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a IscsiPath.

SELECT
id,
name,
networkBlock,
provisioningState,
systemData,
type
FROM azure_isv.avs.iscsi_paths
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a IscsiPath.

INSERT INTO azure_isv.avs.iscsi_paths (
properties,
resource_group_name,
private_cloud_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: iscsi_paths
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the iscsi_paths resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the iscsi_paths resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the iscsi_paths resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      networkBlock: "{{ networkBlock }}"

REPLACE examples

create_or_update

Create a IscsiPath.

REPLACE azure_isv.avs.iscsi_paths
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a IscsiPath.

DELETE FROM azure_isv.avs.iscsi_paths
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_by_private_cloud

List IscsiPath resources by PrivateCloud.

EXEC azure_isv.avs.iscsi_paths.list_by_private_cloud 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_cloud_name='{{ private_cloud_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;