disk_pools

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

Overview

Name	disk_pools
Type	Resource
Id	azure.storage_pool.disk_pools

Fields

vw_disk_pools

Name	Datatype	Description
additional_capabilities	text	field from the properties object
availability_zones	text	field from the properties object
diskPoolName	text	field from the properties object
disks	text	field from the properties object
location	text	The geo-location where the resource lives.
managed_by	text	field from the properties object
managed_by_extended	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	Sku for ARM resource
status	text	field from the properties object
subnet_id	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.

disk_pools

Name	Datatype	Description
location	string	The geo-location where the resource lives.
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	Disk Pool response properties.
sku	object	Sku for ARM resource
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	diskPoolName, resourceGroupName, subscriptionId	Get a Disk pool.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets a list of DiskPools in a resource group.
list_by_subscription	SELECT	subscriptionId	Gets a list of Disk Pools in a subscription
create_or_update	INSERT	diskPoolName, resourceGroupName, subscriptionId, data__location, data__properties, data__sku	Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior.
delete	DELETE	diskPoolName, resourceGroupName, subscriptionId	Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
update	UPDATE	diskPoolName, resourceGroupName, subscriptionId, data__properties	Update a Disk pool.
deallocate	EXEC	diskPoolName, resourceGroupName, subscriptionId	Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.
start	EXEC	diskPoolName, resourceGroupName, subscriptionId	The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
upgrade	EXEC	diskPoolName, resourceGroupName, subscriptionId	Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.

SELECT examples

Gets a list of Disk Pools in a subscription

vw_disk_pools

SELECT
additional_capabilities,
availability_zones,
diskPoolName,
disks,
location,
managed_by,
managed_by_extended,
provisioning_state,
resourceGroupName,
sku,
status,
subnet_id,
subscriptionId,
system_data,
tags
FROM azure.storage_pool.vw_disk_pools
WHERE subscriptionId = '{{ subscriptionId }}';

disk_pools

SELECT
location,
managedBy,
managedByExtended,
properties,
sku,
systemData,
tags
FROM azure.storage_pool.disk_pools
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new disk_pools resource.

All Properties

/*+ create */
INSERT INTO azure.storage_pool.disk_pools (
diskPoolName,
resourceGroupName,
subscriptionId,
data__location,
data__properties,
data__sku,
sku,
properties,
tags,
location,
managedBy,
managedByExtended
)
SELECT 
'{{ diskPoolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ data__sku }}',
'{{ sku }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ managedBy }}',
'{{ managedByExtended }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
    - name: properties
      value:
        - name: availabilityZones
          value:
            - []
        - name: disks
          value:
            - - name: id
                value: string
        - name: subnetId
          value: string
        - name: additionalCapabilities
          value:
            - []
    - name: tags
      value: object
    - name: location
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: managedBy
      value: []
    - name: managedByExtended
      value: []

UPDATE example

Updates a disk_pools resource.

/*+ update */
UPDATE azure.storage_pool.disk_pools
SET 
managedBy = '{{ managedBy }}',
managedByExtended = '{{ managedByExtended }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
diskPoolName = '{{ diskPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND data__properties = '{{ data__properties }}';

DELETE example

Deletes the specified disk_pools resource.

/*+ delete */
DELETE FROM azure.storage_pool.disk_pools
WHERE diskPoolName = '{{ diskPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';