你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Snapshot Policies - List Volumes
获取快照策略的卷
获取与快照策略关联的卷
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes?api-version=2024-07-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
account
|
path | True |
string |
NetApp 帐户的名称 正则表达式模式: |
resource
|
path | True |
string |
资源组的名称。 名称不区分大小写。 |
snapshot
|
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 Flow
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
SnapshotPolicies_ListVolumes
示例请求
示例响应
{
"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"
}
}
]
}
定义
名称 | 说明 |
---|---|
avs |
avsDataStore |
Chown |
此参数指定有权更改文件的所有权的人员。 受限 - 只有根用户可以更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。 |
cool |
coolAccessRetrievalPolicy 根据启用冷访问卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:默认值 - 数据将从冷层提取到随机读取时的标准存储。 此策略是默认值。 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 |
卷组中卷放置的应用程序特定参数 |
remote |
要迁移到 ANF 的卷的完整路径。 迁移卷必需 |
replication |
复制属性 |
Replication |
附表 |
Security |
卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议) |
Service |
serviceLevel |
smb |
smbAccessBasedEnumeration |
smb |
smbNonBrowsable |
snapshot |
与快照策略关联的卷 |
system |
与创建和上次修改资源相关的元数据。 |
volume |
卷资源 |
volume |
卷备份属性 |
volume |
卷重定位属性 |
volume |
卷快照属性 |
Volume |
存储到网络邻近度 |
avsDataStore
avsDataStore
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
avsDataStore 已禁用 |
Enabled |
string |
avsDataStore 已启用 |
ChownMode
此参数指定有权更改文件的所有权的人员。 受限 - 只有根用户可以更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。
名称 | 类型 | 说明 |
---|---|---|
Restricted |
string |
|
Unrestricted |
string |
coolAccessRetrievalPolicy
coolAccessRetrievalPolicy 根据启用冷访问卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:默认值 - 数据将从冷层提取到随机读取时的标准存储。 此策略是默认值。 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 |
卷组中卷放置的应用程序特定参数的值 |
remotePath
要迁移到 ANF 的卷的完整路径。 迁移卷必需
名称 | 类型 | 说明 |
---|---|---|
externalHostName |
string |
ONTAP 主机的路径 |
serverName |
string |
ONTAP 主机上的服务器的名称 |
volumeName |
string |
服务器上的卷的名称 |
replicationObject
复制属性
名称 | 类型 | 说明 |
---|---|---|
endpointType |
指示本地卷是卷复制的源还是目标 |
|
remotePath |
要迁移到 ANF 的卷的完整路径。 迁移卷必需 |
|
remoteVolumeRegion |
string |
卷复制另一端的远程区域。 |
remoteVolumeResourceId |
string |
远程卷的资源 ID。 跨区域复制和跨区域复制所必需的 |
replicationId |
string |
Id |
replicationSchedule |
附表 |
ReplicationSchedule
附表
名称 | 类型 | 说明 |
---|---|---|
_10minutely |
string |
|
daily |
string |
|
hourly |
string |
SecurityStyle
卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议)
名称 | 类型 | 说明 |
---|---|---|
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 共享设置 |
snapshotPolicyVolumeList
与快照策略关联的卷
名称 | 类型 | 说明 |
---|---|---|
value |
volume[] |
卷列表 |
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/s 的实际吞吐量 |
|
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 根据启用冷访问卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:默认值 - 数据将从冷层提取到随机读取时的标准存储。 此策略是默认值。 OnRead - 所有客户端驱动的数据读取都从冷层提取到顺序读取和随机读取的标准存储。 从不 - 没有从冷层提取到标准存储的客户端驱动数据。 |
||
properties.coolnessPeriod |
integer |
指定客户端不访问的数据分层后的天数。 |
|
properties.creationToken |
string |
创建令牌或文件路径 |
|
properties.dataProtection |
DataProtection |
||
properties.dataStoreResourceId |
string[] |
dataStoreResourceId |
|
properties.defaultGroupQuotaInKiBs |
integer |
0 |
卷的默认组配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiBs。 |
properties.defaultUserQuotaInKiBs |
integer |
0 |
卷的默认用户配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KIB。 |
properties.deleteBaseSnapshot |
boolean |
如果启用(true),则卷创建的快照将在卷创建操作完成后自动删除。 默认值为 false |
|
properties.effectiveNetworkFeatures | Basic |
网络功能 |
|
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 |
恢复 |
|
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)默认为 ntfs(对于双重协议或 CIFS 协议) |
|
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/s 中可实现的最大吞吐量,此卷仅接受为手动 qosType 卷的输入 |
|
properties.unixPermissions |
string |
以八进制 4 位格式接受的 NFS 卷的 UNIX 权限。 第一位数字选择设置用户 ID(4)、设置组 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 |
策略强制实施 |
volumeRelocationProperties
卷重定位属性
名称 | 类型 | 说明 |
---|---|---|
readyToBeFinalized |
boolean |
搬迁已完成,已准备好清理 |
relocationRequested |
boolean |
是否已为此卷请求重定位 |
volumeSnapshotProperties
卷快照属性
名称 | 类型 | 说明 |
---|---|---|
snapshotPolicyId |
string |
快照策略 ResourceId |
VolumeStorageToNetworkProximity
存储到网络邻近度
名称 | 类型 | 说明 |
---|---|---|
AcrossT2 |
string |
标准跨T2 存储到网络连接。 |
Default |
string |
基本存储到网络连接。 |
T1 |
string |
标准 T1 存储到网络连接。 |
T2 |
string |
标准 T2 存储到网络连接。 |