你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Volumes - List
描述所有卷
列出容量池中的所有卷
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes?api-version=2023-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
account
|
path | True |
string |
NetApp 帐户的名称 正则表达式模式: |
pool
|
path | True |
string |
容量池的名称 正则表达式模式: |
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
subscription
|
path | True |
string uuid |
目标订阅的 ID。 该值必须是 UUID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Volumes_List
示例请求
示例响应
{
"value": [
{
"id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
"name": "account1/pool1/volume1",
"type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
"location": "eastus",
"properties": {
"fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
"creationToken": "some-amazing-filepath",
"usageThreshold": 107374182400,
"serviceLevel": "Premium",
"provisioningState": "Succeeded",
"throughputMibps": 128,
"subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
"networkFeatures": "Standard",
"networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4",
"storageToNetworkProximity": "T2"
}
}
]
}
定义
名称 | 说明 |
---|---|
avs |
avsDataStore |
Chown |
此参数指定谁有权更改文件的所有权。 受限 - 只有根用户才能更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。 |
cool |
coolAccessRetrievalPolicy 根据已启用冷访问的卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:Default - 数据将在随机读取时从冷层拉取到标准存储。 此策略是默认策略。 OnRead - 在顺序读取和随机读取时,所有客户端驱动的数据读取都会从冷层拉取到标准存储。 从不 - 不会将客户端驱动的数据从冷层拉取到标准存储。 |
created |
创建资源的标识类型。 |
Data |
DataProtection |
enable |
指示是否在卷上启用子卷操作的标志 |
Encryption |
用于加密卷中的数据的密钥源。 如果 NetApp 帐户具有 encryption.keySource = “Microsoft.KeyVault”,则适用。 (不区分大小写) 的可能值为:“Microsoft.NetApp, Microsoft.KeyVault” |
Endpoint |
指示本地卷是卷复制的源还是目标 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Export |
exportPolicy |
export |
卷导出策略规则 |
file |
指示是否基于卷上存在的活动诊断设置为卷启用文件访问日志的标志。 |
mount |
装载目标属性 |
Network |
网络功能 |
placement |
卷在卷组中放置的应用程序特定参数 |
replication |
复制属性 |
Replication |
计划 |
Security |
卷(默认 unix)的安全样式,对于双协议或 CIFS 协议,默认为 ntfs |
Service |
serviceLevel |
smb |
smbAccessBasedEnumeration |
smb |
smbNonBrowsable |
system |
与资源的创建和上次修改相关的元数据。 |
volume |
卷资源 |
volume |
卷备份属性 |
volume |
卷资源列表 |
volume |
卷重定位属性 |
volume |
卷快照属性 |
Volume |
存储到网络邻近感应 |
avsDataStore
avsDataStore
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
avsDataStore 已禁用 |
Enabled |
string |
avsDataStore 已启用 |
ChownMode
此参数指定谁有权更改文件的所有权。 受限 - 只有根用户才能更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。
名称 | 类型 | 说明 |
---|---|---|
Restricted |
string |
|
Unrestricted |
string |
coolAccessRetrievalPolicy
coolAccessRetrievalPolicy 根据已启用冷访问的卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:Default - 数据将在随机读取时从冷层拉取到标准存储。 此策略是默认策略。 OnRead - 在顺序读取和随机读取时,所有客户端驱动的数据读取都会从冷层拉取到标准存储。 从不 - 不会将客户端驱动的数据从冷层拉取到标准存储。
名称 | 类型 | 说明 |
---|---|---|
Default |
string |
|
Never |
string |
|
OnRead |
string |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataProtection
DataProtection
名称 | 类型 | 说明 |
---|---|---|
backup |
备份 |
|
replication |
复制 |
|
snapshot |
快照 |
|
volumeRelocation |
VolumeRelocation |
enableSubvolumes
指示是否在卷上启用子卷操作的标志
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
未启用子卷 |
Enabled |
string |
已启用子卷 |
EncryptionKeySource
用于加密卷中的数据的密钥源。 如果 NetApp 帐户具有 encryption.keySource = “Microsoft.KeyVault”,则适用。 (不区分大小写) 的可能值为:“Microsoft.NetApp, Microsoft.KeyVault”
名称 | 类型 | 说明 |
---|---|---|
Microsoft.KeyVault |
string |
客户管理的密钥加密 |
Microsoft.NetApp |
string |
Microsoft 管理的密钥加密 |
EndpointType
指示本地卷是卷复制的源还是目标
名称 | 类型 | 说明 |
---|---|---|
dst |
string |
|
src |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
ExportPolicy
exportPolicy
名称 | 类型 | 说明 |
---|---|---|
rules |
导出策略规则 |
exportPolicyRule
卷导出策略规则
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
allowedClients |
string |
客户端入口规范为逗号分隔字符串,包含 IPv4CIDR、IPv4 主机名和主机名 |
|
chownMode | Restricted |
此参数指定谁有权更改文件的所有权。 受限 - 只有根用户才能更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。 |
|
cifs |
boolean |
允许 CIFS 协议 |
|
hasRootAccess |
boolean |
True |
具有对卷的根访问权限 |
kerberos5ReadOnly |
boolean |
False |
Kerberos5 只读访问权限。 要与 swagger 版本 2020-05-01 或更高版本一起使用 |
kerberos5ReadWrite |
boolean |
False |
Kerberos5 读取和写入访问权限。 要与 swagger 版本 2020-05-01 或更高版本一起使用 |
kerberos5iReadOnly |
boolean |
False |
Kerberos5i 只读访问权限。 要与 swagger 版本 2020-05-01 或更高版本一起使用 |
kerberos5iReadWrite |
boolean |
False |
Kerberos5i 读取和写入访问权限。 要与 swagger 版本 2020-05-01 或更高版本一起使用 |
kerberos5pReadOnly |
boolean |
False |
Kerberos5p 只读访问权限。 要与 swagger 版本 2020-05-01 或更高版本一起使用 |
kerberos5pReadWrite |
boolean |
False |
Kerberos5p 读取和写入访问权限。 要与 swagger 版本 2020-05-01 或更高版本一起使用 |
nfsv3 |
boolean |
允许 NFSv3 协议。 仅对 NFSv3 类型卷启用 |
|
nfsv41 |
boolean |
允许 NFSv4.1 协议。 仅为 NFSv4.1 类型卷启用 |
|
ruleIndex |
integer |
订单索引 |
|
unixReadOnly |
boolean |
只读访问 |
|
unixReadWrite |
boolean |
读取和写入访问权限 |
fileAccessLogs
指示是否基于卷上存在的活动诊断设置为卷启用文件访问日志的标志。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
fileAccessLogs 未启用 |
Enabled |
string |
fileAccessLogs 已启用 |
mountTargetProperties
装载目标属性
名称 | 类型 | 说明 |
---|---|---|
fileSystemId |
string |
fileSystemId |
ipAddress |
string |
ipAddress |
mountTargetId |
string |
mountTargetId |
smbServerFqdn |
string |
smbServerFQDN |
NetworkFeatures
网络功能
名称 | 类型 | 说明 |
---|---|---|
Basic |
string |
基本网络功能。 |
Basic_Standard |
string |
从基本网络功能更新到标准网络功能。 |
Standard |
string |
标准网络功能。 |
Standard_Basic |
string |
从标准网络功能更新到基本网络功能。 |
placementKeyValuePairs
卷在卷组中放置的应用程序特定参数
名称 | 类型 | 说明 |
---|---|---|
key |
string |
用于在卷组中放置卷的应用程序特定参数的键 |
value |
string |
卷组中卷放置的应用程序特定参数的值 |
replicationObject
复制属性
名称 | 类型 | 说明 |
---|---|---|
endpointType |
指示本地卷是卷复制的源还是目标 |
|
remoteVolumeRegion |
string |
卷复制的另一端的远程区域。 |
remoteVolumeResourceId |
string |
远程卷的资源 ID。 |
replicationId |
string |
ID |
replicationSchedule |
计划 |
ReplicationSchedule
计划
名称 | 类型 | 说明 |
---|---|---|
_10minutely |
string |
|
daily |
string |
|
hourly |
string |
SecurityStyle
卷(默认 unix)的安全样式,对于双协议或 CIFS 协议,默认为 ntfs
名称 | 类型 | 说明 |
---|---|---|
ntfs |
string |
|
unix |
string |
ServiceLevel
serviceLevel
名称 | 类型 | 说明 |
---|---|---|
Premium |
string |
“高级”服务级别 |
Standard |
string |
标准服务级别 |
StandardZRS |
string |
区域冗余存储服务级别 |
Ultra |
string |
“超级”服务级别 |
smbAccessBasedEnumeration
smbAccessBasedEnumeration
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
smbAccessBasedEnumeration 共享设置已禁用 |
Enabled |
string |
smbAccessBasedEnumeration 共享设置已启用 |
smbNonBrowsable
smbNonBrowsable
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
smbNonBrowsable 共享设置已禁用 |
Enabled |
string |
smbNonBrowsable 共享设置已启用 |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源的创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |
volume
卷资源
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
etag |
string |
一个唯一的只读字符串,每当资源更新时都会更改。 |
|
id |
string |
资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
|
location |
string |
资源所在的地理位置 |
|
name |
string |
资源的名称 |
|
properties.actualThroughputMibps |
number |
基于大小和 serviceLevel 计算的自动 qosType 卷的实际吞吐量(以 MiB/秒为单位) |
|
properties.avsDataStore | Disabled |
avsDataStore |
|
properties.backupId |
string |
备份 ID |
|
properties.baremetalTenantId |
string |
Baremetal 租户 ID |
|
properties.capacityPoolResourceId |
string |
用于通过卷组创建卷的池资源 ID |
|
properties.cloneProgress |
integer |
从另一个卷的快照还原卷时,将显示此克隆过程的完成百分比。 当此值为空/null 时,此卷上当前不会发生任何克隆过程。 此值将在克隆过程中每 5 分钟更新一次。 |
|
properties.coolAccess |
boolean |
False |
指定是否为卷启用冷访问 (分层) 。 |
properties.coolAccessRetrievalPolicy |
coolAccessRetrievalPolicy 根据已启用冷访问的卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:Default - 在随机读取时,数据将从冷层拉取到标准存储。 此策略是默认策略。 OnRead - 所有客户端驱动的数据读取都是在顺序读取和随机读取时从冷层拉取到标准存储的。 从不 - 不会将客户端驱动的数据从冷层拉取到标准存储。 |
||
properties.coolnessPeriod |
integer |
指定将客户端未访问的数据分层的天数。 |
|
properties.creationToken |
string |
创建令牌或文件路径 |
|
properties.dataProtection |
DataProtection |
||
properties.dataStoreResourceId |
string[] |
dataStoreResourceId |
|
properties.defaultGroupQuotaInKiBs |
integer |
0 |
卷的默认组配额(以 KiB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiB。 |
properties.defaultUserQuotaInKiBs |
integer |
0 |
卷的默认用户配额(以 KiB 为单位)。 如果设置了 isDefaultQuotaEnabled,则 4 KiB 的最小值将应用 。 |
properties.deleteBaseSnapshot |
boolean |
如果启用 (true) 卷创建自的快照将在卷创建操作完成后自动删除。 默认为 false |
|
properties.enableSubvolumes | Disabled |
指示是否在卷上启用子卷操作的标志 |
|
properties.encrypted |
boolean |
指定卷是否加密。 仅适用于在 2022-01-01 之后创建或更新的卷。 |
|
properties.encryptionKeySource | Microsoft.NetApp |
用于加密卷中的数据的密钥源。 如果 NetApp 帐户的 encryption.keySource = 'Microsoft.KeyVault' ,则适用。 (不区分大小写) 的可能值为:“Microsoft.NetApp, Microsoft.KeyVault” |
|
properties.exportPolicy |
exportPolicy |
||
properties.fileAccessLogs | Disabled |
指示是否基于卷上存在的活动诊断设置为卷启用文件访问日志的标志。 |
|
properties.fileSystemId |
string |
FileSystem ID |
|
properties.isDefaultQuotaEnabled |
boolean |
False |
指定是否为卷启用默认配额。 |
properties.isLargeVolume |
boolean |
False |
是较大的卷 |
properties.isRestoring |
boolean |
Restoring |
|
properties.kerberosEnabled |
boolean |
False |
描述卷是否为 KerberosEnabled。 与 swagger 版本 2020-05-01 或更高版本一起使用 |
properties.keyVaultPrivateEndpointResourceId |
string |
KeyVault 的专用终结点的资源 ID。 它必须与卷位于同一 VNET 中。 仅当 encryptionKeySource = 'Microsoft.KeyVault' 时适用。 |
|
properties.ldapEnabled |
boolean |
False |
指定是否为给定 NFS 卷启用 LDAP。 |
properties.maximumNumberOfFiles |
integer |
允许的最大文件数。 需要服务请求才能进行更改。 仅当卷配额超过 4TiB 时,才允许更改。 |
|
properties.mountTargets |
mountTargets |
||
properties.networkFeatures | Basic |
网络功能 |
|
properties.networkSiblingSetId |
string |
网络同级集 ID |
|
properties.originatingResourceId |
string |
原始资源 ID |
|
properties.placementRules |
卷放置规则 |
||
properties.protocolTypes |
string[] |
protocolTypes |
|
properties.provisionedAvailabilityZone |
string |
预配的可用性区域 |
|
properties.provisioningState |
string |
Azure 生命周期管理 |
|
properties.proximityPlacementGroup |
string |
与卷关联的邻近放置组 |
|
properties.securityStyle | unix |
卷的安全样式,默认 unix,对于双协议或 CIFS 协议,默认为 ntfs |
|
properties.serviceLevel | Premium |
serviceLevel |
|
properties.smbAccessBasedEnumeration |
smbAccessBasedEnumeration |
||
properties.smbContinuouslyAvailable |
boolean |
False |
为 smb 卷启用连续可用的共享属性。 仅适用于 SMB 卷 |
properties.smbEncryption |
boolean |
False |
为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用 |
properties.smbNonBrowsable |
smbNonBrowsable |
||
properties.snapshotDirectoryVisible |
boolean |
True |
如果启用 (true) 卷将包含只读快照目录,该目录提供对卷的每个快照的访问权限, (默认为 true) 。 |
properties.snapshotId |
string |
快照 ID |
|
properties.storageToNetworkProximity |
存储到网络邻近感应 |
||
properties.subnetId |
string |
委托子网的 Azure 资源 URI。 必须具有委派 Microsoft.NetApp/volumes |
|
properties.t2Network |
string |
T2 网络信息 |
|
properties.throughputMibps |
number |
此卷可以实现的最大吞吐量(以 MiB/秒为单位),此吞吐量将仅接受为手动 qosType 卷的输入 |
|
properties.unixPermissions |
string |
接受八进制 4 位格式的 NFS 卷的 UNIX 权限。 第一个数字选择 (4) 设置的用户 ID,将组 ID (2) 和粘滞 (1) 属性。 第二位数字为文件所有者选择权限:读取 (4) ,写入 (2) 并执行 (1) 。 第三个选择同一组中其他用户的权限。 第四个,适用于不在组中的其他用户。 0755 - 向所有者授予读/写/执行权限,向组和其他用户授予读取/执行权限。 |
|
properties.usageThreshold |
integer |
0 |
usageThreshold |
properties.volumeGroupName |
string |
卷组名称 |
|
properties.volumeSpecName |
string |
卷规格名称是卷组中特定卷的应用程序特定指定或标识符,例如数据、日志 |
|
properties.volumeType |
string |
此卷的类型是什么。 对于跨区域复制中的目标卷,请将类型设置为 DataProtection |
|
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
||
tags |
object |
资源标记。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
|
zones |
string[] |
可用性区域 |
volumeBackupProperties
卷备份属性
名称 | 类型 | 说明 |
---|---|---|
backupPolicyId |
string |
备份策略资源 ID |
backupVaultId |
string |
备份保管库资源 ID |
policyEnforced |
boolean |
策略已强制实施 |
volumeList
卷资源列表
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
用于获取下一组结果的 URL。 |
value |
volume[] |
卷列表 |
volumeRelocationProperties
卷重定位属性
名称 | 类型 | 说明 |
---|---|---|
readyToBeFinalized |
boolean |
已完成重定位,并已准备好清理 |
relocationRequested |
boolean |
是否已请求重定位此卷 |
volumeSnapshotProperties
卷快照属性
名称 | 类型 | 说明 |
---|---|---|
snapshotPolicyId |
string |
快照策略 ResourceId |
VolumeStorageToNetworkProximity
存储到网络邻近感应
名称 | 类型 | 说明 |
---|---|---|
AcrossT2 |
string |
标准跨T2 存储到网络连接。 |
Default |
string |
基本存储到网络连接。 |
T1 |
string |
标准 T1 存储到网络连接。 |
T2 |
string |
标准 T2 存储到网络连接。 |