Skip to main content

pools

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

Overview​

Namepools
TypeResource
Idazure.netapp.pools

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
coolAccessbooleanIf enabled (true) the pool can contain cool Access enabled volumes.
customThroughputMibpsintegerMaximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level.
encryptionTypestringEncryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. Known values are: "Single" and "Double". (Single, Double)
etagstring"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
locationstringThe geo-location where the resource lives. Required.
poolIdstringUUID v4 used to identify the Pool.
provisioningStatestringAzure lifecycle management.
qosTypestringThe qos type of the pool. Known values are: "Auto" and "Manual". (Auto, Manual)
serviceLevelstringThe service level of the file system. Required. Known values are: "Standard", "Premium", "Ultra", "StandardZRS", and "Flexible". (Standard, Premium, Ultra, StandardZRS, Flexible)
sizeintegerProvisioned size of the pool (in bytes). Allowed values are 512GiB (549755813888 bytes) or in 1TiB chunks (value must be multiple of 1099511627776). Required.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
totalThroughputMibpsnumberTotal throughput of pool in MiB/s.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
utilizedThroughputMibpsnumberUtilized throughput of pool in MiB/s.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, account_name, pool_name, subscription_idGet details of the specified capacity pool.
listselectresource_group_name, account_name, subscription_idList all capacity pools in the NetApp Account.
create_or_updateinsertresource_group_name, account_name, pool_name, subscription_id, location, propertiesCreate or Update a capacity pool.
updateupdateresource_group_name, account_name, pool_name, subscription_idPatch the specified capacity pool.
create_or_updatereplaceresource_group_name, account_name, pool_name, subscription_id, location, propertiesCreate or Update a capacity pool.
deletedeleteresource_group_name, account_name, pool_name, subscription_idDelete the specified capacity pool.

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.

NameDatatypeDescription
account_namestringThe name of the NetApp account. Required.
pool_namestringThe name of the capacity pool. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

Get details of the specified capacity pool.

SELECT
id,
name,
coolAccess,
customThroughputMibps,
encryptionType,
etag,
location,
poolId,
provisioningState,
qosType,
serviceLevel,
size,
systemData,
tags,
totalThroughputMibps,
type,
utilizedThroughputMibps
FROM azure.netapp.pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create or Update a capacity pool.

INSERT INTO azure.netapp.pools (
tags,
location,
properties,
resource_group_name,
account_name,
pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

UPDATE examples​

Patch the specified capacity pool.

UPDATE azure.netapp.pools
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples​

Create or Update a capacity pool.

REPLACE azure.netapp.pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples​

Delete the specified capacity pool.

DELETE FROM azure.netapp.pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;