Pools - Update

Service:

Azure NetApp Files

API Version:

2026-01-01

Patch the specified capacity pool

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	The name of the NetApp account
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$	The name of the capacity pool
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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 minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
location	string	Resource location
properties.coolAccess	boolean	If enabled (true) the pool can contain cool Access enabled volumes.
properties.customThroughputMibps	integer (int32)	Maximum 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
properties.qosType	QosType	The qos type of the pool
properties.size	integer (int64)	Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
tags	object	Resource tags

Responses

Name	Type	Description
200 OK	CapacityPool	Azure operation completed successfully.
202 Accepted		Resource update request accepted. Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

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_Update

Pools_Update_CustomThroughput

Pools_Update

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1?api-version=2026-01-01

{}

Java

import com.azure.resourcemanager.netapp.models.CapacityPool;

/**
 * Samples for Pools Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-01-01/Pools_Update.json
     */
    /**
     * Sample code: Pools_Update.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void poolsUpdate(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        CapacityPool resource
            = manager.pools().getWithResponse("myRG", "account1", "pool1", com.azure.core.util.Context.NONE).getValue();
        resource.update().apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python pools_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.pools.begin_update(
        resource_group_name="myRG",
        account_name="account1",
        pool_name="pool1",
        body={
            "id": "str",
            "location": "str",
            "name": "str",
            "properties": {"coolAccess": bool, "customThroughputMibps": 0, "qosType": "str", "size": 0},
            "tags": {"str": "str"},
            "type": "str",
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-01-01/Pools_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v10"
)

// Generated from example definition: 2026-01-01/Pools_Update.json
func ExamplePoolsClient_BeginUpdate_poolsUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPoolsClient().BeginUpdate(ctx, "myRG", "account1", "pool1", armnetapp.CapacityPoolPatch{}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetapp.PoolsClientUpdateResponse{
	// 	CapacityPool: &armnetapp.CapacityPool{
	// 		Name: to.Ptr("account1/pool1"),
	// 		Type: to.Ptr("Microsoft.NetApp/netAppAccounts/capacityPools"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1"),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armnetapp.PoolProperties{
	// 			PoolID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca7778"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			QosType: to.Ptr(armnetapp.QosTypeManual),
	// 			ServiceLevel: to.Ptr(armnetapp.ServiceLevelPremium),
	// 			Size: to.Ptr[int64](4398046511104),
	// 			TotalThroughputMibps: to.Ptr[float32](281.474),
	// 			UtilizedThroughputMibps: to.Ptr[float32](100.47),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to patch the specified capacity pool
 *
 * @summary patch the specified capacity pool
 * x-ms-original-file: 2026-01-01/Pools_Update.json
 */
async function poolsUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.pools.update("myRG", "account1", "pool1", {});
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/NetApp/stable/2026-01-01/examples/Pools_Update.json
// this example is just showing the usage of "Pools_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CapacityPoolResource created on azure
// for more information of creating CapacityPoolResource, please refer to the document of CapacityPoolResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
string poolName = "pool1";
ResourceIdentifier capacityPoolResourceId = CapacityPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
CapacityPoolResource capacityPool = client.GetCapacityPoolResource(capacityPoolResourceId);

// invoke the operation
CapacityPoolPatch patch = new CapacityPoolPatch(default);
ArmOperation<CapacityPoolResource> lro = await capacityPool.UpdateAsync(WaitUntil.Completed, patch);
CapacityPoolResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CapacityPoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "account1/pool1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1",
  "location": "eastus",
  "properties": {
    "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "provisioningState": "Succeeded",
    "qosType": "Manual",
    "serviceLevel": "Premium",
    "size": 4398046511104,
    "totalThroughputMibps": 281.474,
    "utilizedThroughputMibps": 100.47
  }
}

Status code:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2026-01-01&operationResultResponseType=Location

Pools_Update_CustomThroughput

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1?api-version=2026-01-01

{}

Java

import com.azure.resourcemanager.netapp.models.CapacityPool;

/**
 * Samples for Pools Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-01-01/Pools_Update_CustomThroughput.json
     */
    /**
     * Sample code: Pools_Update_CustomThroughput.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void poolsUpdateCustomThroughput(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        CapacityPool resource = manager.pools()
            .getWithResponse("myRG", "account1", "customPool1", com.azure.core.util.Context.NONE).getValue();
        resource.update().apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python pools_update_custom_throughput.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.pools.begin_update(
        resource_group_name="myRG",
        account_name="account1",
        pool_name="customPool1",
        body={
            "id": "str",
            "location": "str",
            "name": "str",
            "properties": {"coolAccess": bool, "customThroughputMibps": 0, "qosType": "str", "size": 0},
            "tags": {"str": "str"},
            "type": "str",
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-01-01/Pools_Update_CustomThroughput.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v10"
)

// Generated from example definition: 2026-01-01/Pools_Update_CustomThroughput.json
func ExamplePoolsClient_BeginUpdate_poolsUpdateCustomThroughput() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPoolsClient().BeginUpdate(ctx, "myRG", "account1", "customPool1", armnetapp.CapacityPoolPatch{}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetapp.PoolsClientUpdateResponse{
	// 	CapacityPool: &armnetapp.CapacityPool{
	// 		Name: to.Ptr("account1/customPool1"),
	// 		Type: to.Ptr("Microsoft.NetApp/netAppAccounts/capacityPools"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1"),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armnetapp.PoolProperties{
	// 			CustomThroughputMibps: to.Ptr[int32](128),
	// 			PoolID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca7778"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			QosType: to.Ptr(armnetapp.QosTypeManual),
	// 			ServiceLevel: to.Ptr(armnetapp.ServiceLevelFlexible),
	// 			Size: to.Ptr[int64](4398046511104),
	// 			TotalThroughputMibps: to.Ptr[float32](128),
	// 			UtilizedThroughputMibps: to.Ptr[float32](100.47),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to patch the specified capacity pool
 *
 * @summary patch the specified capacity pool
 * x-ms-original-file: 2026-01-01/Pools_Update_CustomThroughput.json
 */
async function poolsUpdateCustomThroughput() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.pools.update("myRG", "account1", "customPool1", {});
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/NetApp/stable/2026-01-01/examples/Pools_Update_CustomThroughput.json
// this example is just showing the usage of "Pools_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CapacityPoolResource created on azure
// for more information of creating CapacityPoolResource, please refer to the document of CapacityPoolResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
string poolName = "customPool1";
ResourceIdentifier capacityPoolResourceId = CapacityPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
CapacityPoolResource capacityPool = client.GetCapacityPoolResource(capacityPoolResourceId);

// invoke the operation
CapacityPoolPatch patch = new CapacityPoolPatch(default);
ArmOperation<CapacityPoolResource> lro = await capacityPool.UpdateAsync(WaitUntil.Completed, patch);
CapacityPoolResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CapacityPoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "account1/customPool1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1",
  "location": "eastus",
  "properties": {
    "customThroughputMibps": 128,
    "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "provisioningState": "Succeeded",
    "qosType": "Manual",
    "serviceLevel": "Flexible",
    "size": 4398046511104,
    "totalThroughputMibps": 128,
    "utilizedThroughputMibps": 100.47
  }
}

Status code:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2026-01-01&operationResultResponseType=Location

Definitions

Name	Description
CapacityPool	Capacity pool resource
CapacityPoolPatch	Capacity pool patch resource
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
QosType	The qos type of the pool
ServiceLevel	The service level of the file system
systemData	Metadata pertaining to creation and last modification of the resource.

CapacityPool

Object

Capacity pool resource

Name	Type	Default value	Description
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.")
id	string (arm-id)		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.customThroughputMibps	integer (int32)		Maximum 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
properties.encryptionType	enum: Double Single	Single	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 minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$		UUID v4 used to identify the Pool
properties.provisioningState	string		Azure lifecycle management
properties.qosType	QosType	Auto	The qos type of the pool
properties.serviceLevel	ServiceLevel	Premium	The service level of the file system
properties.size	integer (int64)	0	Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
properties.totalThroughputMibps	number (float)		Total throughput of pool in MiB/s
properties.utilizedThroughputMibps	number (float)		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"

CapacityPoolPatch

Object

Capacity pool patch resource

Name	Type	Description
id	string	Resource Id
location	string	Resource location
name	string	Resource name
properties.coolAccess	boolean	If enabled (true) the pool can contain cool Access enabled volumes.
properties.customThroughputMibps	integer (int32)	Maximum 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
properties.qosType	QosType	The qos type of the pool
properties.size	integer (int64)	Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).
tags	object	Resource tags
type	string	Resource type

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

QosType

Enumeration

The qos type of the pool

Value	Description
Auto	qos type Auto
Manual	qos type Manual

ServiceLevel

Enumeration

The service level of the file system

Value	Description
Standard	Standard service level
Premium	Premium service level
Ultra	Ultra service level
StandardZRS	Zone redundant storage service level. This will be deprecated soon.
Flexible	Flexible service level

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.