volume_groups

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

Overview

Name	volume_groups
Type	Resource
Id	azure.netapp.volume_groups

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.
groupMetaData	object	Volume group details.
location	string	Resource location.
provisioningState	string	Azure lifecycle management.
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".
volumes	array	List of volumes from group.

list_by_net_app_account

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
groupMetaData	object	Volume group details.
location	string	Resource location.
provisioningState	string	Azure lifecycle management.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, volume_group_name, subscription_id		Get details of the specified volume group.
list_by_net_app_account	select	resource_group_name, account_name, subscription_id		List all volume groups for given account.
create	insert	resource_group_name, account_name, volume_group_name, subscription_id		Create a volume group along with specified volumes.
delete	delete	resource_group_name, account_name, volume_group_name, subscription_id		Delete the specified volume group only if there are no volumes under volume group.

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
account_name	string	The name of the NetApp account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
volume_group_name	string	The name of the volumeGroup. Required.

SELECT examples

get

Get details of the specified volume group.

SELECT
id,
name,
groupMetaData,
location,
provisioningState,
systemData,
type,
volumes
FROM azure.netapp.volume_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND volume_group_name = '{{ volume_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_net_app_account

List all volume groups for given account.

SELECT
id,
name,
groupMetaData,
location,
provisioningState,
type
FROM azure.netapp.volume_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a volume group along with specified volumes.

INSERT INTO azure.netapp.volume_groups (
properties,
location,
resource_group_name,
account_name,
volume_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ volume_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: volume_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the volume_groups resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the volume_groups resource.
  - name: volume_group_name
    value: "{{ volume_group_name }}"
    description: Required parameter for the volume_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the volume_groups resource.
  - name: properties
    description: |
      Volume group properties.
    value:
      provisioningState: "{{ provisioningState }}"
      groupMetaData:
        groupDescription: "{{ groupDescription }}"
        applicationType: "{{ applicationType }}"
        applicationIdentifier: "{{ applicationIdentifier }}"
        globalPlacementRules:
          - key: "{{ key }}"
            value: "{{ value }}"
        volumesCount: {{ volumesCount }}
      volumes:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          tags: "{{ tags }}"
          zones: "{{ zones }}"
          properties:
            fileSystemId: "{{ fileSystemId }}"
            creationToken: "{{ creationToken }}"
            serviceLevel: "{{ serviceLevel }}"
            usageThreshold: {{ usageThreshold }}
            exportPolicy:
              rules:
                - ruleIndex: {{ ruleIndex }}
                  unixReadOnly: {{ unixReadOnly }}
                  unixReadWrite: {{ unixReadWrite }}
                  kerberos5ReadOnly: {{ kerberos5ReadOnly }}
                  kerberos5ReadWrite: {{ kerberos5ReadWrite }}
                  kerberos5iReadOnly: {{ kerberos5iReadOnly }}
                  kerberos5iReadWrite: {{ kerberos5iReadWrite }}
                  kerberos5pReadOnly: {{ kerberos5pReadOnly }}
                  kerberos5pReadWrite: {{ kerberos5pReadWrite }}
                  cifs: {{ cifs }}
                  nfsv3: {{ nfsv3 }}
                  nfsv41: {{ nfsv41 }}
                  allowedClients: "{{ allowedClients }}"
                  hasRootAccess: {{ hasRootAccess }}
                  chownMode: "{{ chownMode }}"
            protocolTypes:
              - "{{ protocolTypes }}"
            provisioningState: "{{ provisioningState }}"
            snapshotId: "{{ snapshotId }}"
            deleteBaseSnapshot: {{ deleteBaseSnapshot }}
            backupId: "{{ backupId }}"
            baremetalTenantId: "{{ baremetalTenantId }}"
            subnetId: "{{ subnetId }}"
            networkFeatures: "{{ networkFeatures }}"
            effectiveNetworkFeatures: "{{ effectiveNetworkFeatures }}"
            networkSiblingSetId: "{{ networkSiblingSetId }}"
            storageToNetworkProximity: "{{ storageToNetworkProximity }}"
            mountTargets:
              - mountTargetId: "{{ mountTargetId }}"
                fileSystemId: "{{ fileSystemId }}"
                ipAddress: "{{ ipAddress }}"
                smbServerFqdn: "{{ smbServerFqdn }}"
            volumeType: "{{ volumeType }}"
            dataProtection:
              backup:
                backupPolicyId: "{{ backupPolicyId }}"
                policyEnforced: {{ policyEnforced }}
                backupVaultId: "{{ backupVaultId }}"
              replication:
                replicationId: "{{ replicationId }}"
                endpointType: "{{ endpointType }}"
                replicationSchedule: "{{ replicationSchedule }}"
                remoteVolumeResourceId: "{{ remoteVolumeResourceId }}"
                remotePath: "{{ remotePath }}"
                remoteVolumeRegion: "{{ remoteVolumeRegion }}"
                destinationReplications: "{{ destinationReplications }}"
                externalReplicationSetupStatus: "{{ externalReplicationSetupStatus }}"
                externalReplicationSetupInfo: "{{ externalReplicationSetupInfo }}"
                mirrorState: "{{ mirrorState }}"
                relationshipStatus: "{{ relationshipStatus }}"
              snapshot:
                snapshotPolicyId: "{{ snapshotPolicyId }}"
              volumeRelocation:
                relocationRequested: {{ relocationRequested }}
                readyToBeFinalized: {{ readyToBeFinalized }}
              ransomwareProtection:
                desiredRansomwareProtectionState: "{{ desiredRansomwareProtectionState }}"
                actualRansomwareProtectionState: "{{ actualRansomwareProtectionState }}"
            acceptGrowCapacityPoolForShortTermCloneSplit: "{{ acceptGrowCapacityPoolForShortTermCloneSplit }}"
            isRestoring: {{ isRestoring }}
            snapshotDirectoryVisible: {{ snapshotDirectoryVisible }}
            kerberosEnabled: {{ kerberosEnabled }}
            securityStyle: "{{ securityStyle }}"
            smbEncryption: {{ smbEncryption }}
            smbAccessBasedEnumeration: "{{ smbAccessBasedEnumeration }}"
            smbNonBrowsable: "{{ smbNonBrowsable }}"
            smbContinuouslyAvailable: {{ smbContinuouslyAvailable }}
            throughputMibps: {{ throughputMibps }}
            actualThroughputMibps: {{ actualThroughputMibps }}
            encryptionKeySource: "{{ encryptionKeySource }}"
            keyVaultPrivateEndpointResourceId: "{{ keyVaultPrivateEndpointResourceId }}"
            ldapEnabled: {{ ldapEnabled }}
            ldapServerType: "{{ ldapServerType }}"
            coolAccess: {{ coolAccess }}
            coolnessPeriod: {{ coolnessPeriod }}
            coolAccessRetrievalPolicy: "{{ coolAccessRetrievalPolicy }}"
            coolAccessTieringPolicy: "{{ coolAccessTieringPolicy }}"
            unixPermissions: "{{ unixPermissions }}"
            cloneProgress: {{ cloneProgress }}
            fileAccessLogs: "{{ fileAccessLogs }}"
            avsDataStore: "{{ avsDataStore }}"
            dataStoreResourceId:
              - "{{ dataStoreResourceId }}"
            isDefaultQuotaEnabled: {{ isDefaultQuotaEnabled }}
            defaultUserQuotaInKiBs: {{ defaultUserQuotaInKiBs }}
            defaultGroupQuotaInKiBs: {{ defaultGroupQuotaInKiBs }}
            maximumNumberOfFiles: {{ maximumNumberOfFiles }}
            volumeGroupName: "{{ volumeGroupName }}"
            capacityPoolResourceId: "{{ capacityPoolResourceId }}"
            proximityPlacementGroup: "{{ proximityPlacementGroup }}"
            t2Network: "{{ t2Network }}"
            volumeSpecName: "{{ volumeSpecName }}"
            encrypted: {{ encrypted }}
            placementRules:
              - key: "{{ key }}"
                value: "{{ value }}"
            enableSubvolumes: "{{ enableSubvolumes }}"
            provisionedAvailabilityZone: "{{ provisionedAvailabilityZone }}"
            isLargeVolume: {{ isLargeVolume }}
            largeVolumeType: "{{ largeVolumeType }}"
            originatingResourceId: "{{ originatingResourceId }}"
            inheritedSizeInBytes: {{ inheritedSizeInBytes }}
            language: "{{ language }}"
            breakthroughMode: "{{ breakthroughMode }}"
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.

DELETE examples

delete

Delete the specified volume group only if there are no volumes under volume group.

DELETE FROM azure.netapp.volume_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND volume_group_name = '{{ volume_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;