storage_pools

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

Overview

Name	storage_pools
Type	Resource
Id	azure_isv.purestorageblock.storage_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.
availabilityZone	string	Azure Availability Zone the Pool is located in. Required.
avs	object	AVS connection state summary.
dataRetentionPeriod	integer	How long a destroyed object is kept before being eradicated, in seconds.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisionedBandwidthMbPerSec	integer	Total bandwidth provisioned for the pool, in MB/s. Required.
provisionedIops	integer	Total I/O operations per second (IOPS) provisioned for the pool.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Deleting, Accepted)
reservationResourceId	string	Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to. Required.
storagePoolInternalId	string	Pure Storage's internal ID of the storage pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnetInjection	object	Network properties of the storage pool. Required.

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.
availabilityZone	string	Azure Availability Zone the Pool is located in. Required.
avs	object	AVS connection state summary.
dataRetentionPeriod	integer	How long a destroyed object is kept before being eradicated, in seconds.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisionedBandwidthMbPerSec	integer	Total bandwidth provisioned for the pool, in MB/s. Required.
provisionedIops	integer	Total I/O operations per second (IOPS) provisioned for the pool.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Deleting, Accepted)
reservationResourceId	string	Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to. Required.
storagePoolInternalId	string	Pure Storage's internal ID of the storage pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnetInjection	object	Network properties of the storage pool. Required.

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.
availabilityZone	string	Azure Availability Zone the Pool is located in. Required.
avs	object	AVS connection state summary.
dataRetentionPeriod	integer	How long a destroyed object is kept before being eradicated, in seconds.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisionedBandwidthMbPerSec	integer	Total bandwidth provisioned for the pool, in MB/s. Required.
provisionedIops	integer	Total I/O operations per second (IOPS) provisioned for the pool.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Deleting, Accepted)
reservationResourceId	string	Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to. Required.
storagePoolInternalId	string	Pure Storage's internal ID of the storage pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vnetInjection	object	Network properties of the storage pool. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_pool_name, subscription_id		Get a storage pool.
list_by_resource_group	select	resource_group_name, subscription_id		List storage pools by resource group.
list_by_subscription	select	subscription_id		List storage pools by Azure subscription ID.
create	insert	resource_group_name, storage_pool_name, subscription_id, location		Create a storage pool.
update	update	resource_group_name, storage_pool_name, subscription_id		Update a storage pool.
delete	delete	resource_group_name, storage_pool_name, subscription_id		Delete a storage pool.
get_health_status	exec	resource_group_name, storage_pool_name, subscription_id		Retrieve health metrics of a storage pool.
get_avs_connection	exec	resource_group_name, storage_pool_name, subscription_id		Returns current information about an on-going connection to an AVS instance.
get_avs_status	exec	resource_group_name, storage_pool_name, subscription_id		Returns the status of the storage pool connection to AVS.
enable_avs_connection	exec	resource_group_name, storage_pool_name, subscription_id, sddcResourceId		Initiate a connection between the storage pool and a specified AVS SDDC resource.
disable_avs_connection	exec	resource_group_name, storage_pool_name, subscription_id		Disable the existing AVS connection.
finalize_avs_connection	exec	resource_group_name, storage_pool_name, subscription_id		Finalize an already started AVS connection to a specific AVS SDDC.
repair_avs_connection	exec	resource_group_name, storage_pool_name, subscription_id		Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_pool_name	string	Name of the storage pool. Required.
subscription_id	string

SELECT examples

get

Get a storage pool.

SELECT
id,
name,
availabilityZone,
avs,
dataRetentionPeriod,
identity,
location,
provisionedBandwidthMbPerSec,
provisionedIops,
provisioningState,
reservationResourceId,
storagePoolInternalId,
systemData,
tags,
type,
vnetInjection
FROM azure_isv.purestorageblock.storage_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_pool_name = '{{ storage_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List storage pools by resource group.

SELECT
id,
name,
availabilityZone,
avs,
dataRetentionPeriod,
identity,
location,
provisionedBandwidthMbPerSec,
provisionedIops,
provisioningState,
reservationResourceId,
storagePoolInternalId,
systemData,
tags,
type,
vnetInjection
FROM azure_isv.purestorageblock.storage_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List storage pools by Azure subscription ID.

SELECT
id,
name,
availabilityZone,
avs,
dataRetentionPeriod,
identity,
location,
provisionedBandwidthMbPerSec,
provisionedIops,
provisioningState,
reservationResourceId,
storagePoolInternalId,
systemData,
tags,
type,
vnetInjection
FROM azure_isv.purestorageblock.storage_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a storage pool.

INSERT INTO azure_isv.purestorageblock.storage_pools (
tags,
location,
properties,
identity,
resource_group_name,
storage_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ storage_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_pools resource.
  - name: storage_pool_name
    value: "{{ storage_pool_name }}"
    description: Required parameter for the storage_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      storagePoolInternalId: "{{ storagePoolInternalId }}"
      availabilityZone: "{{ availabilityZone }}"
      vnetInjection:
        subnetId: "{{ subnetId }}"
        vnetId: "{{ vnetId }}"
      dataRetentionPeriod: {{ dataRetentionPeriod }}
      provisionedBandwidthMbPerSec: {{ provisionedBandwidthMbPerSec }}
      provisionedIops: {{ provisionedIops }}
      avs:
        avsEnabled: {{ avsEnabled }}
        sddcResourceId: "{{ sddcResourceId }}"
      provisioningState: "{{ provisioningState }}"
      reservationResourceId: "{{ reservationResourceId }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a storage pool.

UPDATE azure_isv.purestorageblock.storage_pools
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_pool_name = '{{ storage_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a storage pool.

DELETE FROM azure_isv.purestorageblock.storage_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_pool_name = '{{ storage_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_health_status

Retrieve health metrics of a storage pool.

EXEC azure_isv.purestorageblock.storage_pools.get_health_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_pool_name='{{ storage_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_avs_connection

Returns current information about an on-going connection to an AVS instance.

EXEC azure_isv.purestorageblock.storage_pools.get_avs_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_pool_name='{{ storage_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_avs_status

Returns the status of the storage pool connection to AVS.

EXEC azure_isv.purestorageblock.storage_pools.get_avs_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_pool_name='{{ storage_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_avs_connection

Initiate a connection between the storage pool and a specified AVS SDDC resource.

EXEC azure_isv.purestorageblock.storage_pools.enable_avs_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_pool_name='{{ storage_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"sddcResourceId": "{{ sddcResourceId }}"
}'
;

disable_avs_connection

Disable the existing AVS connection.

EXEC azure_isv.purestorageblock.storage_pools.disable_avs_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_pool_name='{{ storage_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

finalize_avs_connection

Finalize an already started AVS connection to a specific AVS SDDC.

EXEC azure_isv.purestorageblock.storage_pools.finalize_avs_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_pool_name='{{ storage_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"serviceInitializationDataEnc": "{{ serviceInitializationDataEnc }}", 
"serviceInitializationData": "{{ serviceInitializationData }}"
}'
;

repair_avs_connection

Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance.

EXEC azure_isv.purestorageblock.storage_pools.repair_avs_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_pool_name='{{ storage_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;