volume_groups

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

Overview

Name	volume_groups
Type	Resource
Id	azure.elastic_san.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.
encryption	string	Type of encryption. Known values are: "EncryptionAtRestWithPlatformKey" and "EncryptionAtRestWithCustomerManagedKey". (EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerManagedKey)
encryptionProperties	object	Encryption Properties describing Key Vault and Identity information.
enforceDataIntegrityCheckForIscsi	boolean	A boolean indicating whether or not Data Integrity Check is enabled.
identity	object	The identity of the resource.
networkAcls	object	A collection of rules governing the accessibility from specific network locations.
privateEndpointConnections	array	The list of Private Endpoint Connections.
protocolType	string	Type of storage target. Known values are: "Iscsi" and "None". (Iscsi, None)
provisioningState	string	State of the operation on the resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
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_by_elastic_san

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.
encryption	string	Type of encryption. Known values are: "EncryptionAtRestWithPlatformKey" and "EncryptionAtRestWithCustomerManagedKey". (EncryptionAtRestWithPlatformKey, EncryptionAtRestWithCustomerManagedKey)
encryptionProperties	object	Encryption Properties describing Key Vault and Identity information.
enforceDataIntegrityCheckForIscsi	boolean	A boolean indicating whether or not Data Integrity Check is enabled.
identity	object	The identity of the resource.
networkAcls	object	A collection of rules governing the accessibility from specific network locations.
privateEndpointConnections	array	The list of Private Endpoint Connections.
protocolType	string	Type of storage target. Known values are: "Iscsi" and "None". (Iscsi, None)
provisioningState	string	State of the operation on the resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
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, elastic_san_name, volume_group_name, subscription_id		Get an VolumeGroups.
list_by_elastic_san	select	resource_group_name, elastic_san_name, subscription_id		List VolumeGroups.
create	insert	resource_group_name, elastic_san_name, volume_group_name, subscription_id		Create a Volume Group.
update	update	resource_group_name, elastic_san_name, volume_group_name, subscription_id		Update an VolumeGroup.
delete	delete	resource_group_name, elastic_san_name, volume_group_name, subscription_id		Delete an VolumeGroup.

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
elastic_san_name	string	The name of the ElasticSan. 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 an VolumeGroups.

SELECT
id,
name,
encryption,
encryptionProperties,
enforceDataIntegrityCheckForIscsi,
identity,
networkAcls,
privateEndpointConnections,
protocolType,
provisioningState,
systemData,
type
FROM azure.elastic_san.volume_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND elastic_san_name = '{{ elastic_san_name }}' -- required
AND volume_group_name = '{{ volume_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_elastic_san

List VolumeGroups.

SELECT
id,
name,
encryption,
encryptionProperties,
enforceDataIntegrityCheckForIscsi,
identity,
networkAcls,
privateEndpointConnections,
protocolType,
provisioningState,
systemData,
type
FROM azure.elastic_san.volume_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND elastic_san_name = '{{ elastic_san_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a Volume Group.

INSERT INTO azure.elastic_san.volume_groups (
identity,
properties,
resource_group_name,
elastic_san_name,
volume_group_name,
subscription_id
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ elastic_san_name }}',
'{{ volume_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
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: elastic_san_name
    value: "{{ elastic_san_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: identity
    description: |
      The identity of the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    description: |
      Properties of VolumeGroup.
    value:
      provisioningState: "{{ provisioningState }}"
      protocolType: "{{ protocolType }}"
      encryption: "{{ encryption }}"
      encryptionProperties:
        keyVaultProperties:
          keyName: "{{ keyName }}"
          keyVersion: "{{ keyVersion }}"
          keyVaultUri: "{{ keyVaultUri }}"
          currentVersionedKeyIdentifier: "{{ currentVersionedKeyIdentifier }}"
          lastKeyRotationTimestamp: "{{ lastKeyRotationTimestamp }}"
          currentVersionedKeyExpirationTimestamp: "{{ currentVersionedKeyExpirationTimestamp }}"
        identity:
          userAssignedIdentity: "{{ userAssignedIdentity }}"
      networkAcls:
        virtualNetworkRules:
          - id: "{{ id }}"
            action: "{{ action }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            provisioningState: "{{ provisioningState }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            groupIds:
              - "{{ groupIds }}"
      enforceDataIntegrityCheckForIscsi: {{ enforceDataIntegrityCheckForIscsi }}

UPDATE examples

update

Update an VolumeGroup.

UPDATE azure.elastic_san.volume_groups
SET 
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND elastic_san_name = '{{ elastic_san_name }}' --required
AND volume_group_name = '{{ volume_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
properties,
systemData,
type;

DELETE examples

delete

Delete an VolumeGroup.

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