elastic_capacity_pools

Creates, updates, deletes, gets or lists an elastic_capacity_pools resource.

Overview

Name	elastic_capacity_pools
Type	Resource
Id	azure.netapp.elastic_capacity_pools

Fields

The following fields are returned by SELECT queries:

check_volume_file_path_availability

Name	Datatype	Description
isAvailable	string	True indicates name is valid and available. False indicates the name is invalid, unavailable, or both. Known values are: "True" and "False". (True, False)
message	string	If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
reason	string	Invalid indicates the name provided does not match Azure NetApp Files naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

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.
activeDirectoryConfigResourceId	string	The Azure Resource URI for an Active Directory configuration. This is used by all the SMB volumes within the pool.
availabilityStatus	string	Current availability status of the resource. Known values are: "Online" and "Offline". (Online, Offline)
currentZone	string	Indicates the current zone of the pool. This can be changed for zoneRedundant service level pool with the changeZone action.
eTag	string	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.
encryption	object	Encryption settings.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
serviceLevel	string	The service level of the elastic capacity pool. Required. "ZoneRedundant" (ZoneRedundant)
size	integer	Provisioned size of the pool (in bytes). For zoneRedundant service level pool, value must be in the range 1TiB to 16TiB or 1TiB to 128TiB for supported region. Values expressed in bytes as multiples of 1TiB till 16TiB and in multiples of 8TiB from 24TiB to 128TiB. Pool size can't be shrunk once it is created. Required.
subnetResourceId	string	The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/elasticVolumes, this is used by all the volumes within the pool. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalThroughputMibps	number	Total throughput of the pool in MiB/s.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

list_by_elastic_account

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.
activeDirectoryConfigResourceId	string	The Azure Resource URI for an Active Directory configuration. This is used by all the SMB volumes within the pool.
availabilityStatus	string	Current availability status of the resource. Known values are: "Online" and "Offline". (Online, Offline)
currentZone	string	Indicates the current zone of the pool. This can be changed for zoneRedundant service level pool with the changeZone action.
eTag	string	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.
encryption	object	Encryption settings.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
serviceLevel	string	The service level of the elastic capacity pool. Required. "ZoneRedundant" (ZoneRedundant)
size	integer	Provisioned size of the pool (in bytes). For zoneRedundant service level pool, value must be in the range 1TiB to 16TiB or 1TiB to 128TiB for supported region. Values expressed in bytes as multiples of 1TiB till 16TiB and in multiples of 8TiB from 24TiB to 128TiB. Pool size can't be shrunk once it is created. Required.
subnetResourceId	string	The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/elasticVolumes, this is used by all the volumes within the pool. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalThroughputMibps	number	Total throughput of the pool in MiB/s.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_volume_file_path_availability	select	resource_group_name, account_name, pool_name, subscription_id		Check if an Elastic Volume file path is available within the given Elastic Capacity Pool.
get	select	resource_group_name, account_name, pool_name, subscription_id		Get the NetApp Elastic Capacity Pool.
list_by_elastic_account	select	resource_group_name, account_name, subscription_id		List and describe all NetApp Elastic Capacity Pools in the Elastic NetApp Account.
create_or_update	insert	resource_group_name, account_name, pool_name, subscription_id, location		Create or update the specified NetApp Elastic Capacity Pool within the resource group and NetApp Elastic Account.
update	update	resource_group_name, account_name, pool_name, subscription_id		Patch the specified NetApp Elastic Capacity Pool.
create_or_update	replace	resource_group_name, account_name, pool_name, subscription_id, location		Create or update the specified NetApp Elastic Capacity Pool within the resource group and NetApp Elastic Account.
delete	delete	resource_group_name, account_name, pool_name, subscription_id		Delete the specified NetApp Elastic Capacity Pool.
change_zone	exec	resource_group_name, account_name, pool_name, subscription_id, newZone		Moves pool to another zone.

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
account_name	string	The name of the ElasticAccount. Required.
pool_name	string	The name of the ElasticCapacityPool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

check_volume_file_path_availability

Check if an Elastic Volume file path is available within the given Elastic Capacity Pool.

SELECT
isAvailable,
message,
reason
FROM azure.netapp.elastic_capacity_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
;

get

Get the NetApp Elastic Capacity Pool.

SELECT
id,
name,
activeDirectoryConfigResourceId,
availabilityStatus,
currentZone,
eTag,
encryption,
location,
provisioningState,
serviceLevel,
size,
subnetResourceId,
systemData,
tags,
totalThroughputMibps,
type,
zones
FROM azure.netapp.elastic_capacity_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
;

list_by_elastic_account

List and describe all NetApp Elastic Capacity Pools in the Elastic NetApp Account.

SELECT
id,
name,
activeDirectoryConfigResourceId,
availabilityStatus,
currentZone,
eTag,
encryption,
location,
provisioningState,
serviceLevel,
size,
subnetResourceId,
systemData,
tags,
totalThroughputMibps,
type,
zones
FROM azure.netapp.elastic_capacity_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the specified NetApp Elastic Capacity Pool within the resource group and NetApp Elastic Account.

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

Manifest

# Description fields are for documentation purposes
- name: elastic_capacity_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the elastic_capacity_pools resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the elastic_capacity_pools resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the elastic_capacity_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the elastic_capacity_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:
      size: {{ size }}
      serviceLevel: "{{ serviceLevel }}"
      provisioningState: "{{ provisioningState }}"
      encryption:
        elasticPoolEncryptionKeySource: "{{ elasticPoolEncryptionKeySource }}"
        keyVaultPrivateEndpointResourceId: "{{ keyVaultPrivateEndpointResourceId }}"
      totalThroughputMibps: {{ totalThroughputMibps }}
      subnetResourceId: "{{ subnetResourceId }}"
      currentZone: "{{ currentZone }}"
      availabilityStatus: "{{ availabilityStatus }}"
      activeDirectoryConfigResourceId: "{{ activeDirectoryConfigResourceId }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.

UPDATE examples

update

Patch the specified NetApp Elastic Capacity Pool.

UPDATE azure.netapp.elastic_capacity_pools
SET 
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,
zones;

REPLACE examples

create_or_update

Create or update the specified NetApp Elastic Capacity Pool within the resource group and NetApp Elastic Account.

REPLACE azure.netapp.elastic_capacity_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
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
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples

delete

Delete the specified NetApp Elastic Capacity Pool.

DELETE FROM azure.netapp.elastic_capacity_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
;

Lifecycle Methods

change_zone

Moves pool to another zone.

EXEC azure.netapp.elastic_capacity_pools.change_zone 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"newZone": "{{ newZone }}"
}'
;