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

The following fields are returned by SELECT queries:

get

Operation completed successfully; retrieved Disk pool.

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	Properties of Disk Pool.
sku	object	Determines the SKU of the Disk pool
systemData	object	Resource metadata required by ARM RPC
tags	object	Resource tags.

list_by_resource_group

Operation completed successfully; retrieved diskPools by resource group

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	Properties of Disk Pool.
sku	object	Determines the SKU of the Disk pool
systemData	object	Resource metadata required by ARM RPC
tags	object	Resource tags.

list_by_subscription

Operation completed successfully; retrieved diskPools by subscription

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	Properties of Disk Pool.
sku	object	Determines the SKU of the Disk pool
systemData	object	Resource metadata required by ARM RPC
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, diskPoolName		Get a Disk pool.
list_by_resource_group	select	subscriptionId, resourceGroupName		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	subscriptionId, resourceGroupName, diskPoolName, data__properties, data__location, data__sku		Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior.
update	update	subscriptionId, resourceGroupName, diskPoolName, data__properties		Update a Disk pool.
delete	delete	subscriptionId, resourceGroupName, diskPoolName		Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
start	exec	subscriptionId, resourceGroupName, diskPoolName		The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
deallocate	exec	subscriptionId, resourceGroupName, diskPoolName		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.
upgrade	exec	subscriptionId, resourceGroupName, diskPoolName		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.

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
diskPoolName	string	The name of the Disk Pool.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a Disk pool.

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

list_by_resource_group

Gets a list of DiskPools in a resource group.

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

list_by_subscription

Gets a list of Disk Pools in a subscription

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

INSERT examples

create_or_update

Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior.

INSERT INTO azure.storage_pool.disk_pools (
data__sku,
data__properties,
data__tags,
data__location,
data__managedBy,
data__managedByExtended,
subscriptionId,
resourceGroupName,
diskPoolName
)
SELECT 
'{{ sku }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}' /* required */,
'{{ managedBy }}',
'{{ managedByExtended }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ diskPoolName }}'
RETURNING
location,
managedBy,
managedByExtended,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: disk_pools
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the disk_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the disk_pools resource.
    - name: diskPoolName
      value: string
      description: Required parameter for the disk_pools resource.
    - name: sku
      value: object
      description: |
        Determines the SKU of the Disk Pool
    - name: properties
      value: object
      description: |
        Properties for Disk Pool create request.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives.
    - name: managedBy
      value: string
      description: |
        Azure resource id. Indicates if this resource is managed by another Azure resource.
    - name: managedByExtended
      value: array
      description: |
        List of Azure resource ids that manage this resource.

UPDATE examples

update

Update a Disk pool.

UPDATE azure.storage_pool.disk_pools
SET 
data__managedBy = '{{ managedBy }}',
data__managedByExtended = '{{ managedByExtended }}',
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskPoolName = '{{ diskPoolName }}' --required
AND data__properties = '{{ properties }}' --required
RETURNING
location,
managedBy,
managedByExtended,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.

DELETE FROM azure.storage_pool.disk_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskPoolName = '{{ diskPoolName }}' --required
;

Lifecycle Methods

start

The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.

EXEC azure.storage_pool.disk_pools.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@diskPoolName='{{ diskPoolName }}' --required
;

deallocate

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.

EXEC azure.storage_pool.disk_pools.deallocate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@diskPoolName='{{ diskPoolName }}' --required
;

upgrade

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.

EXEC azure.storage_pool.disk_pools.upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@diskPoolName='{{ diskPoolName }}' --required
;