datastores

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

Overview

Name	datastores
Type	Resource
Id	azure_isv.avs.datastores

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.
diskPoolVolume	object	An iSCSI volume.
elasticSanVolume	object	An Elastic SAN volume.
netAppVolume	object	An Azure NetApp Files volume.
provisioningState	string	The state of the datastore provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Pending", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Cancelled, Pending, Creating, Updating, Deleting)
pureStorageVolume	object	A Pure Storage volume.
status	string	The operational status of the datastore. Known values are: "Unknown", "Accessible", "Inaccessible", "Attached", "Detached", "LostCommunication", and "DeadOrError". (Unknown, Accessible, Inaccessible, Attached, Detached, LostCommunication, DeadOrError)
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".

list

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.
diskPoolVolume	object	An iSCSI volume.
elasticSanVolume	object	An Elastic SAN volume.
netAppVolume	object	An Azure NetApp Files volume.
provisioningState	string	The state of the datastore provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Cancelled", "Pending", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Cancelled, Pending, Creating, Updating, Deleting)
pureStorageVolume	object	A Pure Storage volume.
status	string	The operational status of the datastore. Known values are: "Unknown", "Accessible", "Inaccessible", "Attached", "Detached", "LostCommunication", and "DeadOrError". (Unknown, Accessible, Inaccessible, Attached, Detached, LostCommunication, DeadOrError)
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, cluster_name, datastore_name, subscription_id		Get a Datastore.
list	select	resource_group_name, private_cloud_name, cluster_name, subscription_id		List Datastore resources by Cluster.
create_or_update	insert	resource_group_name, private_cloud_name, cluster_name, datastore_name, subscription_id		Create a Datastore.
create_or_update	replace	resource_group_name, private_cloud_name, cluster_name, datastore_name, subscription_id		Create a Datastore.
delete	delete	resource_group_name, private_cloud_name, cluster_name, datastore_name, subscription_id		Delete a Datastore.

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
cluster_name	string	Name of the cluster. Required.
datastore_name	string	Name of the datastore. Required.
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 Datastore.

SELECT
id,
name,
diskPoolVolume,
elasticSanVolume,
netAppVolume,
provisioningState,
pureStorageVolume,
status,
systemData,
type
FROM azure_isv.avs.datastores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND datastore_name = '{{ datastore_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Datastore resources by Cluster.

SELECT
id,
name,
diskPoolVolume,
elasticSanVolume,
netAppVolume,
provisioningState,
pureStorageVolume,
status,
systemData,
type
FROM azure_isv.avs.datastores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Datastore.

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

Manifest

# Description fields are for documentation purposes
- name: datastores
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the datastores resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the datastores resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the datastores resource.
  - name: datastore_name
    value: "{{ datastore_name }}"
    description: Required parameter for the datastores resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the datastores resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      netAppVolume:
        id: "{{ id }}"
      diskPoolVolume:
        targetId: "{{ targetId }}"
        lunName: "{{ lunName }}"
        mountOption: "{{ mountOption }}"
        path: "{{ path }}"
      elasticSanVolume:
        targetId: "{{ targetId }}"
      pureStorageVolume:
        storagePoolId: "{{ storagePoolId }}"
        sizeGb: {{ sizeGb }}
      status: "{{ status }}"

REPLACE examples

create_or_update

Create a Datastore.

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

DELETE examples

delete

Delete a Datastore.

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