Pools - Create Or Update

Reference

Service:: Azure NetApp Files

API Version:: 2023-11-01

Create or Update the specified capacity pool within the resource group
Create or Update a capacity pool

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}?api-version=2023-11-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the NetApp account Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$`
poolName	path	True	string	The name of the capacity pool Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.serviceLevel	True	ServiceLevel	serviceLevel The service level of the file system
properties.size	True	integer	size Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776).
properties.coolAccess		boolean	If enabled (true) the pool can contain cool Access enabled volumes.
properties.encryptionType		encryptionType	encryptionType Encryption 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.
properties.qosType		qosType	qosType The qos type of the pool
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	capacityPool	OK - pool updated
201 Created	capacityPool	Pool created
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Pools_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1?api-version=2023-11-01

{
  "location": "eastus",
  "properties": {
    "size": 4398046511104,
    "serviceLevel": "Premium",
    "qosType": "Auto"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
  "name": "account1/pool1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "serviceLevel": "Premium",
    "size": 4398046511104,
    "qosType": "Auto",
    "totalThroughputMibps": 281.474
  }
}

Status code:: 201

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
  "name": "account1/pool1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "serviceLevel": "Premium",
    "size": 4398046511104,
    "qosType": "Auto",
    "totalThroughputMibps": 281.474
  }
}

Definitions

Name	Description
capacityPool	Capacity pool resource
createdByType	The type of identity that created the resource.
encryptionType	encryptionType
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
qosType	qosType
ServiceLevel	serviceLevel
systemData	Metadata pertaining to creation and last modification of the resource.

capacityPool

Capacity pool resource

Name	Type	Default Value	Description
etag	string		A unique read-only string that changes whenever the resource is updated.
id	string		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.coolAccess	boolean	False	If enabled (true) the pool can contain cool Access enabled volumes.
properties.encryptionType	encryptionType	Single	encryptionType Encryption 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.
properties.poolId	string		poolId UUID v4 used to identify the Pool
properties.provisioningState	string		Azure lifecycle management
properties.qosType	qosType	Auto	qosType The qos type of the pool
properties.serviceLevel	ServiceLevel	Premium	serviceLevel The service level of the file system
properties.size	integer	0	size Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776).
properties.totalThroughputMibps	number		Total throughput of pool in MiB/s
properties.utilizedThroughputMibps	number		Utilized throughput of pool in MiB/s
systemData	systemData		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"

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

encryptionType

Name	Type	Description
Double	string	EncryptionType Double, volumes will use double encryption at rest
Single	string	EncryptionType Single, volumes will use single encryption at rest

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

qosType

Name	Type	Description
Auto	string	qos type Auto
Manual	string	qos type Manual

ServiceLevel

serviceLevel

Name	Type	Description
Premium	string	Premium service level
Standard	string	Standard service level
StandardZRS	string	Zone redundant storage service level
Ultra	string	Ultra service level

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.