Pools - List

服务:

Azure NetApp Files

API 版本:

2025-01-01

描述所有容量池
列出 NetApp 帐户中的所有容量池

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	NetApp 帐户的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此作的 API 版本。

响应

名称	类型	说明
200 OK	capacityPoolList	好的
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Pools_List

示例请求

HTTP

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

Java

/**
 * Samples for Pools List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/Pools_List.json
     */
    /**
     * Sample code: Pools_List.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void poolsList(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.pools().list("myRG", "account1", com.azure.core.util.Context.NONE);
    }
}

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_list.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.pools.list(
        resource_group_name="myRG",
        account_name="account1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/Pools_List.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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/27046dbff974e3901970aa53b29cec6d8ec1342a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/Pools_List.json
func ExamplePoolsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPoolsClient().NewListPager("myRG", "account1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CapacityPoolList = armnetapp.CapacityPoolList{
		// 	Value: []*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.QosTypeAuto),
		// 				ServiceLevel: to.Ptr(armnetapp.ServiceLevelPremium),
		// 				Size: to.Ptr[int64](4398046511104),
		// 				TotalThroughputMibps: to.Ptr[float32](281.474),
		// 				UtilizedThroughputMibps: to.Ptr[float32](100.474),
		// 			},
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to List all capacity pools in the NetApp Account
 *
 * @summary List all capacity pools in the NetApp Account
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/Pools_List.json
 */
async function poolsList() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETAPP_RESOURCE_GROUP"] || "myRG";
  const accountName = "account1";
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.pools.list(resourceGroupName, accountName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/stable/2025-01-01/examples/Pools_List.json
// this example is just showing the usage of "Pools_List" 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 NetAppAccountResource created on azure
// for more information of creating NetAppAccountResource, please refer to the document of NetAppAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
ResourceIdentifier netAppAccountResourceId = NetAppAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
NetAppAccountResource netAppAccount = client.GetNetAppAccountResource(netAppAccountResourceId);

// get the collection of this CapacityPoolResource
CapacityPoolCollection collection = netAppAccount.GetCapacityPools();

// invoke the operation and iterate over the result
await foreach (CapacityPoolResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
        "utilizedThroughputMibps": 100.474
      }
    }
  ]
}

定义

名称	说明
capacityPool	容量池资源
capacityPoolList	容量池资源列表
createdByType	创建资源的标识的类型。
encryptionType	encryptionType
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
qosType	qosType
ServiceLevel	serviceLevel
systemData	与创建和上次修改资源相关的元数据。

capacityPool

Object

容量池资源

名称	类型	默认值	说明
etag	string		一个唯一的只读字符串，每当更新资源时更改。
id	string (arm-id)		资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string		资源所在的地理位置
name	string		资源的名称
properties.coolAccess	boolean	False	如果已启用（true），则池可以包含已启用冷访问的卷。
properties.encryptionType	encryptionType	Single	encryptionType 容量池的加密类型，为此池及其中的所有卷设置静态数据的加密类型。 此值只能在创建新池时设置。
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}$		poolId 用于标识池的 UUID v4
properties.provisioningState	string		Azure 生命周期管理
properties.qosType	qosType	Auto	qosType 池的 Qos 类型
properties.serviceLevel	ServiceLevel	Premium	serviceLevel 文件系统的服务级别
properties.size	integer (int64)	0	大小 池的预配大小（以字节为单位）。 允许的值在 1TiB 区块中（值必须是1099511627776的倍数）。
properties.totalThroughputMibps	number		MiB/s 中池的总吞吐量
properties.utilizedThroughputMibps	number		MiB/s 中池的已利用吞吐量
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

capacityPoolList

Object

容量池资源列表

名称	类型	说明
nextLink	string	用于获取下一组结果的 URL。
value	capacityPool[]	容量池列表

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

encryptionType

枚举

encryptionType

值	说明
Double	EncryptionType Double，卷将使用静态双重加密
Single	EncryptionType Single，卷将使用单个静态加密

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

qosType

枚举

qosType

值	说明
Auto	Qos 类型自动
Manual	Qos 类型手动

ServiceLevel

枚举

serviceLevel

值	说明
Premium	高级服务级别
Standard	标准服务级别
StandardZRS	区域冗余存储服务级别。 这将很快弃用。
Ultra	超级服务级别

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。