disk_pools

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

Overview

Name	disk_pools
Type	Resource
Id	azure_extras.storage_pool.disk_pools

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.
additionalCapabilities	array	List of additional capabilities for Disk Pool.
availabilityZones	array	Logical zone for Disk Pool resource; example: ["1"]. Required.
disks	array	List of Azure Managed Disks to attach to a Disk Pool.
location	string	The geo-location where the resource lives. Required.
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.
provisioningState	string	State of the operation on the resource. Required. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", and "Deleting".
sku	object
status	string	Operational status of the Disk Pool. Required. Known values are: "Invalid", "Unknown", "Healthy", "Unhealthy", "Updating", "Running", "Stopped", and "Stopped (deallocated)".
subnetId	string	Azure Resource ID of a Subnet for the Disk Pool. Required.
systemData	object	Resource metadata required by ARM RPC.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

list_by_resource_group

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.
additionalCapabilities	array	List of additional capabilities for Disk Pool.
availabilityZones	array	Logical zone for Disk Pool resource; example: ["1"]. Required.
disks	array	List of Azure Managed Disks to attach to a Disk Pool.
location	string	The geo-location where the resource lives. Required.
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.
provisioningState	string	State of the operation on the resource. Required. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", and "Deleting".
sku	object
status	string	Operational status of the Disk Pool. Required. Known values are: "Invalid", "Unknown", "Healthy", "Unhealthy", "Updating", "Running", "Stopped", and "Stopped (deallocated)".
subnetId	string	Azure Resource ID of a Subnet for the Disk Pool. Required.
systemData	object	Resource metadata required by ARM RPC.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

list_by_subscription

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.
additionalCapabilities	array	List of additional capabilities for Disk Pool.
availabilityZones	array	Logical zone for Disk Pool resource; example: ["1"]. Required.
disks	array	List of Azure Managed Disks to attach to a Disk Pool.
location	string	The geo-location where the resource lives. Required.
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.
provisioningState	string	State of the operation on the resource. Required. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", and "Deleting".
sku	object
status	string	Operational status of the Disk Pool. Required. Known values are: "Invalid", "Unknown", "Healthy", "Unhealthy", "Updating", "Running", "Stopped", and "Stopped (deallocated)".
subnetId	string	Azure Resource ID of a Subnet for the Disk Pool. Required.
systemData	object	Resource metadata required by ARM RPC.
tags	object	Resource tags.
type	string	The type of the resource. Ex- 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, disk_pool_name, subscription_id		Get a Disk pool.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of DiskPools in a resource group.
list_by_subscription	select	subscription_id		Gets a list of Disk Pools in a subscription.
create_or_update	insert	resource_group_name, disk_pool_name, subscription_id, sku, location, properties		Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior.
update	update	resource_group_name, disk_pool_name, subscription_id		Update a Disk pool.
create_or_update	replace	resource_group_name, disk_pool_name, subscription_id, sku, location, properties		Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior.
delete	delete	resource_group_name, disk_pool_name, subscription_id		Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
list_outbound_network_dependencies_endpoints	exec	resource_group_name, disk_pool_name, subscription_id		Gets the network endpoints of all outbound dependencies of a Disk Pool.
start	exec	resource_group_name, disk_pool_name, subscription_id		The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
deallocate	exec	resource_group_name, disk_pool_name, subscription_id		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	resource_group_name, disk_pool_name, subscription_id		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
disk_pool_name	string	The name of the Disk Pool. 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 Disk pool.

SELECT
id,
name,
additionalCapabilities,
availabilityZones,
disks,
location,
managedBy,
managedByExtended,
provisioningState,
sku,
status,
subnetId,
systemData,
tags,
type
FROM azure_extras.storage_pool.disk_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND disk_pool_name = '{{ disk_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of DiskPools in a resource group.

SELECT
id,
name,
additionalCapabilities,
availabilityZones,
disks,
location,
managedBy,
managedByExtended,
provisioningState,
sku,
status,
subnetId,
systemData,
tags,
type
FROM azure_extras.storage_pool.disk_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets a list of Disk Pools in a subscription.

SELECT
id,
name,
additionalCapabilities,
availabilityZones,
disks,
location,
managedBy,
managedByExtended,
provisioningState,
sku,
status,
subnetId,
systemData,
tags,
type
FROM azure_extras.storage_pool.disk_pools
WHERE subscription_id = '{{ subscription_id }}' -- 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_extras.storage_pool.disk_pools (
sku,
tags,
location,
managedBy,
managedByExtended,
properties,
resource_group_name,
disk_pool_name,
subscription_id
)
SELECT 
'{{ sku }}' /* required */,
'{{ tags }}',
'{{ location }}' /* required */,
'{{ managedBy }}',
'{{ managedByExtended }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ disk_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
managedBy,
managedByExtended,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: disk_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the disk_pools resource.
  - name: disk_pool_name
    value: "{{ disk_pool_name }}"
    description: Required parameter for the disk_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the disk_pools resource.
  - name: sku
    description: |
      Determines the SKU of the Disk Pool. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      Azure resource id. Indicates if this resource is managed by another Azure resource.
  - name: managedByExtended
    value:
      - "{{ managedByExtended }}"
    description: |
      List of Azure resource ids that manage this resource.
  - name: properties
    value:
      availabilityZones:
        - "{{ availabilityZones }}"
      disks:
        - id: "{{ id }}"
      subnetId: "{{ subnetId }}"
      additionalCapabilities:
        - "{{ additionalCapabilities }}"

UPDATE examples

update

Update a Disk pool.

UPDATE azure_extras.storage_pool.disk_pools
SET 
managedBy = '{{ managedBy }}',
managedByExtended = '{{ managedByExtended }}',
sku = '{{ sku }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND disk_pool_name = '{{ disk_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
managedBy,
managedByExtended,
properties,
sku,
systemData,
tags,
type;

REPLACE 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.

REPLACE azure_extras.storage_pool.disk_pools
SET 
sku = '{{ sku }}',
tags = '{{ tags }}',
location = '{{ location }}',
managedBy = '{{ managedBy }}',
managedByExtended = '{{ managedByExtended }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND disk_pool_name = '{{ disk_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND sku = '{{ sku }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
managedBy,
managedByExtended,
properties,
sku,
systemData,
tags,
type;

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_extras.storage_pool.disk_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND disk_pool_name = '{{ disk_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_outbound_network_dependencies_endpoints

Gets the network endpoints of all outbound dependencies of a Disk Pool.

EXEC azure_extras.storage_pool.disk_pools.list_outbound_network_dependencies_endpoints 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_pool_name='{{ disk_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

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

EXEC azure_extras.storage_pool.disk_pools.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_pool_name='{{ disk_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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_extras.storage_pool.disk_pools.deallocate 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_pool_name='{{ disk_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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_extras.storage_pool.disk_pools.upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@disk_pool_name='{{ disk_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;