通过


你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

VolumeProperties interface

卷属性

属性

acceptGrowCapacityPoolForShortTermCloneSplit

在自动拆分短期克隆卷时,如果拆分后的父池没有足够的空间容纳卷,则会自动调整大小,这将导致计费增加。 要接受容量池大小自动增长并创建短期克隆卷,请将属性设置为已接受。

actualThroughputMibps

根据大小和服务级别计算的自动 qosType 卷的实际吞吐量(以 MiB/s 为单位)

avsDataStore

指定是否为 Azure VMware 解决方案 (AVS) 数据存储目的启用卷

backupId

用于标识备份的资源标识符。

baremetalTenantId

唯一裸体租户标识符。

breakthroughMode

指定卷是否在突破模式下运行。

capacityPoolResourceId

通过卷组创建卷时使用的池资源 ID

cloneProgress

从另一卷的快照还原卷时,将显示此克隆过程的完成百分比。 如果此值为空/null,则此卷上当前没有克隆过程。 此值将在克隆期间每隔 5 分钟更新一次。

coolAccess

指定是否为卷启用冷访问(分层)。

coolAccessRetrievalPolicy

coolAccessRetrievalPolicy 根据启用冷访问的卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:默认值 - 随机读取时,数据将从冷层拉取到标准存储。 此策略是默认值。 OnRead - 所有客户端驱动的数据读取都从冷层提取到顺序读取和随机读取的标准存储。 从不 - 没有从冷层提取到标准存储的客户端驱动数据。

coolAccessTieringPolicy

coolAccessTieringPolicy 确定将哪些冷数据块移动到冷层。 此字段的可能值为:自动 - 将快照副本和活动文件系统中的冷用户数据块移动到冷层层。 此策略是默认值。 SnapshotOnly - 将未与活动文件系统关联的卷快照的用户数据块移到冷层。

coolnessPeriod

指定客户端未访问的数据将分层的天数。

creationToken

卷的唯一文件路径。 在创建挂载目标时使用

dataProtection

DataProtection 类型的卷包括一个包含复制详细信息的对象

dataStoreResourceId

数据存储资源唯一标识符

defaultGroupQuotaInKiBs

卷的默认组配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiBs。

defaultUserQuotaInKiBs

卷的默认用户配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiB。

deleteBaseSnapshot

如果启用(true),则卷创建的快照将在卷创建作完成后自动删除。 默认值为 false

effectiveNetworkFeatures

可供卷使用的网络功能类型的有效值,或当前有效更新状态。

enableSubvolumes

指示是否在卷上启用子卷作的标志

encrypted

指定卷是否已加密。 仅适用于在 2022-01-01 之后创建的或更新的卷。

encryptionKeySource

用于加密卷中数据的密钥源。 如果 NetApp 帐户具有 encryption.keySource = “Microsoft.KeyVault”,则适用。 可能的值(不区分大小写)为:“Microsoft.NetApp、Microsoft.KeyVault”

exportPolicy

导出策略规则集

fileAccessLogs

指示是否根据卷上存在的活动诊断设置为卷启用文件访问日志的标志。

fileSystemId

唯一的 FileSystem 标识符。

inheritedSizeInBytes

短期克隆卷与父卷共享的空间(以字节为单位)。

isDefaultQuotaEnabled

指定是否为卷启用默认配额。

isLargeVolume

指定卷是大型卷还是常规卷。

isRestoring

恢复

kerberosEnabled

描述卷是否为 KerberosEnabled。 与 Swagger 版本 2020-05-01 或更高版本一起使用

keyVaultPrivateEndpointResourceId

KeyVault 的专用终结点的资源 ID。 它必须与卷位于同一 VNET 中。 仅当 encryptionKeySource = 'Microsoft.KeyVault' 时才适用。

language

卷支持的语言。

largeVolumeType

指定“大体积块”的类型。 当设置为“LargeVolume”时,将使用标准配置创建大卷。 如果设置为“ExtraLargeVolume7Dot2PiB”,则创建具有更高容量限制 7.2PiB 的超大卷,并启用了冷访问,以更低的成本提供更高的容量限制。

ldapEnabled

指定是否为给定 NFS 卷启用 LDAP。

ldapServerType

指定给定 NFS 卷的 LDAP 服务器类型。

maximumNumberOfFiles

允许的最大文件数。 需要服务请求才能更改。 仅当卷配额超过 4TiB 时,才允许更改。

mountTargets

装载目标列表

networkFeatures

创建卷时可用于卷的网络功能类型的原始值。

networkSiblingSetId

共享网络资源的卷组的网络同级集 ID。

originatingResourceId

从中还原卷的快照或备份的 ID。

placementRules

特定卷的应用程序特定放置规则

protocolTypes

一组协议类型,默认 NFSv3,用于 SMB 协议的 CIFS

provisionedAvailabilityZone

在其中预配卷的可用性区域。 这是指卷所在的逻辑可用性区域。

provisioningState

Azure 生命周期管理

proximityPlacementGroup

与卷关联的邻近放置组

securityStyle

卷的安全样式,默认 unix,默认为 ntfs 表示双协议或 CIFS 协议

serviceLevel

文件系统的服务级别

smbAccessBasedEnumeration

为 SMB 共享启用基于访问的枚举共享属性。 仅适用于 SMB/DualProtocol 卷

smbContinuouslyAvailable

为 smb 卷启用持续可用的共享属性。 仅适用于 SMB 卷

smbEncryption

为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用

smbNonBrowsable

为 SMB 共享启用不可浏览的属性。 仅适用于 SMB/DualProtocol 卷

snapshotDirectoryVisible

如果启用 (true) ,则卷将包含一个只读快照目录,该目录提供对卷的每个快照的访问(默认为 true)。

snapshotId

用于标识快照的资源标识符。

storageToNetworkProximity

为卷的网络邻近度信息提供存储。

subnetId

委托子网的 Azure 资源 URI。 必须具有委派 Microsoft.NetApp/volumes

t2Network

T2 网络信息

throughputMibps

此卷可以实现的最大吞吐量(以 MiB/s 为单位),这将仅被接受为手动 qosType 卷的输入

unixPermissions

以八进制 4 位格式接受的 NFS 卷的 UNIX 权限。 第一位数字选择设置用户 ID(4)、设置组 ID (2) 和粘滞 (1) 属性。 第二位数字选择文件所有者的权限:读取(4)、写入(2)和执行(1)。 第三个选择同一组中其他用户的权限。 第四个用户不在组中。 0755 - 向所有者提供读/写/执行权限,并向组和其他用户授予读取/执行权限。

usageThreshold

文件系统允许的最大存储配额(以字节为单位)。 这是一个仅用于警报的软配额。 对于常规卷,有效值在 50GiB 到 100TiB 之间。 对于大卷,有效值在 100TiB 到 500TiB 的范围内,在特殊情况下,从 2400GiB 到 2400TiB 不等。 对于超大卷,有效值在 2400GiB 到 7200TiB 之间。 以字节表示为 1 GiB 的倍数的值。

volumeGroupName

卷组名称

volumeSpecName

卷规格名称是卷组中特定卷的特定名称或标识符,例如数据、日志

volumeType

这是什么类型的卷。 对于跨区域复制中的目标卷,请将类型设置为 DataProtection。 若要创建克隆卷,请将类型设置为 ShortTermClone

属性详细信息

acceptGrowCapacityPoolForShortTermCloneSplit

在自动拆分短期克隆卷时,如果拆分后的父池没有足够的空间容纳卷,则会自动调整大小,这将导致计费增加。 要接受容量池大小自动增长并创建短期克隆卷,请将属性设置为已接受。

acceptGrowCapacityPoolForShortTermCloneSplit?: string

属性值

string

actualThroughputMibps

根据大小和服务级别计算的自动 qosType 卷的实际吞吐量(以 MiB/s 为单位)

actualThroughputMibps?: number

属性值

number

avsDataStore

指定是否为 Azure VMware 解决方案 (AVS) 数据存储目的启用卷

avsDataStore?: string

属性值

string

backupId

用于标识备份的资源标识符。

backupId?: null | string

属性值

null | string

baremetalTenantId

唯一裸体租户标识符。

baremetalTenantId?: string

属性值

string

breakthroughMode

指定卷是否在突破模式下运行。

breakthroughMode?: string

属性值

string

capacityPoolResourceId

通过卷组创建卷时使用的池资源 ID

capacityPoolResourceId?: string

属性值

string

cloneProgress

从另一卷的快照还原卷时,将显示此克隆过程的完成百分比。 如果此值为空/null,则此卷上当前没有克隆过程。 此值将在克隆期间每隔 5 分钟更新一次。

cloneProgress?: null | number

属性值

null | number

coolAccess

指定是否为卷启用冷访问(分层)。

coolAccess?: boolean

属性值

boolean

coolAccessRetrievalPolicy

coolAccessRetrievalPolicy 根据启用冷访问的卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为:默认值 - 随机读取时,数据将从冷层拉取到标准存储。 此策略是默认值。 OnRead - 所有客户端驱动的数据读取都从冷层提取到顺序读取和随机读取的标准存储。 从不 - 没有从冷层提取到标准存储的客户端驱动数据。

coolAccessRetrievalPolicy?: string

属性值

string

coolAccessTieringPolicy

coolAccessTieringPolicy 确定将哪些冷数据块移动到冷层。 此字段的可能值为:自动 - 将快照副本和活动文件系统中的冷用户数据块移动到冷层层。 此策略是默认值。 SnapshotOnly - 将未与活动文件系统关联的卷快照的用户数据块移到冷层。

coolAccessTieringPolicy?: string

属性值

string

coolnessPeriod

指定客户端未访问的数据将分层的天数。

coolnessPeriod?: number

属性值

number

creationToken

卷的唯一文件路径。 在创建挂载目标时使用

creationToken: string

属性值

string

dataProtection

DataProtection 类型的卷包括一个包含复制详细信息的对象

dataProtection?: VolumePropertiesDataProtection

属性值

dataStoreResourceId

数据存储资源唯一标识符

dataStoreResourceId?: string[]

属性值

string[]

defaultGroupQuotaInKiBs

卷的默认组配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiBs。

defaultGroupQuotaInKiBs?: number

属性值

number

defaultUserQuotaInKiBs

卷的默认用户配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiB。

defaultUserQuotaInKiBs?: number

属性值

number

deleteBaseSnapshot

如果启用(true),则卷创建的快照将在卷创建作完成后自动删除。 默认值为 false

deleteBaseSnapshot?: boolean

属性值

boolean

effectiveNetworkFeatures

可供卷使用的网络功能类型的有效值,或当前有效更新状态。

effectiveNetworkFeatures?: string

属性值

string

enableSubvolumes

指示是否在卷上启用子卷作的标志

enableSubvolumes?: string

属性值

string

encrypted

指定卷是否已加密。 仅适用于在 2022-01-01 之后创建的或更新的卷。

encrypted?: boolean

属性值

boolean

encryptionKeySource

用于加密卷中数据的密钥源。 如果 NetApp 帐户具有 encryption.keySource = “Microsoft.KeyVault”,则适用。 可能的值(不区分大小写)为:“Microsoft.NetApp、Microsoft.KeyVault”

encryptionKeySource?: string

属性值

string

exportPolicy

导出策略规则集

exportPolicy?: VolumePropertiesExportPolicy

属性值

fileAccessLogs

指示是否根据卷上存在的活动诊断设置为卷启用文件访问日志的标志。

fileAccessLogs?: string

属性值

string

fileSystemId

唯一的 FileSystem 标识符。

fileSystemId?: string

属性值

string

inheritedSizeInBytes

短期克隆卷与父卷共享的空间(以字节为单位)。

inheritedSizeInBytes?: null | number

属性值

null | number

isDefaultQuotaEnabled

指定是否为卷启用默认配额。

isDefaultQuotaEnabled?: boolean

属性值

boolean

isLargeVolume

指定卷是大型卷还是常规卷。

isLargeVolume?: boolean

属性值

boolean

isRestoring

恢复

isRestoring?: boolean

属性值

boolean

kerberosEnabled

描述卷是否为 KerberosEnabled。 与 Swagger 版本 2020-05-01 或更高版本一起使用

kerberosEnabled?: boolean

属性值

boolean

keyVaultPrivateEndpointResourceId

KeyVault 的专用终结点的资源 ID。 它必须与卷位于同一 VNET 中。 仅当 encryptionKeySource = 'Microsoft.KeyVault' 时才适用。

keyVaultPrivateEndpointResourceId?: string

属性值

string

language

卷支持的语言。

language?: string

属性值

string

largeVolumeType

指定“大体积块”的类型。 当设置为“LargeVolume”时,将使用标准配置创建大卷。 如果设置为“ExtraLargeVolume7Dot2PiB”,则创建具有更高容量限制 7.2PiB 的超大卷,并启用了冷访问,以更低的成本提供更高的容量限制。

largeVolumeType?: string

属性值

string

ldapEnabled

指定是否为给定 NFS 卷启用 LDAP。

ldapEnabled?: boolean

属性值

boolean

ldapServerType

指定给定 NFS 卷的 LDAP 服务器类型。

ldapServerType?: string

属性值

string

maximumNumberOfFiles

允许的最大文件数。 需要服务请求才能更改。 仅当卷配额超过 4TiB 时,才允许更改。

maximumNumberOfFiles?: number

属性值

number

mountTargets

装载目标列表

mountTargets?: MountTargetProperties[]

属性值

networkFeatures

创建卷时可用于卷的网络功能类型的原始值。

networkFeatures?: string

属性值

string

networkSiblingSetId

共享网络资源的卷组的网络同级集 ID。

networkSiblingSetId?: string

属性值

string

originatingResourceId

从中还原卷的快照或备份的 ID。

originatingResourceId?: null | string

属性值

null | string

placementRules

特定卷的应用程序特定放置规则

placementRules?: PlacementKeyValuePairs[]

属性值

protocolTypes

一组协议类型,默认 NFSv3,用于 SMB 协议的 CIFS

protocolTypes?: string[]

属性值

string[]

provisionedAvailabilityZone

在其中预配卷的可用性区域。 这是指卷所在的逻辑可用性区域。

provisionedAvailabilityZone?: null | string

属性值

null | string

provisioningState

Azure 生命周期管理

provisioningState?: string

属性值

string

proximityPlacementGroup

与卷关联的邻近放置组

proximityPlacementGroup?: string

属性值

string

securityStyle

卷的安全样式,默认 unix,默认为 ntfs 表示双协议或 CIFS 协议

securityStyle?: string

属性值

string

serviceLevel

文件系统的服务级别

serviceLevel?: string

属性值

string

smbAccessBasedEnumeration

为 SMB 共享启用基于访问的枚举共享属性。 仅适用于 SMB/DualProtocol 卷

smbAccessBasedEnumeration?: null | string

属性值

null | string

smbContinuouslyAvailable

为 smb 卷启用持续可用的共享属性。 仅适用于 SMB 卷

smbContinuouslyAvailable?: boolean

属性值

boolean

smbEncryption

为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用

smbEncryption?: boolean

属性值

boolean

smbNonBrowsable

为 SMB 共享启用不可浏览的属性。 仅适用于 SMB/DualProtocol 卷

smbNonBrowsable?: string

属性值

string

snapshotDirectoryVisible

如果启用 (true) ,则卷将包含一个只读快照目录,该目录提供对卷的每个快照的访问(默认为 true)。

snapshotDirectoryVisible?: boolean

属性值

boolean

snapshotId

用于标识快照的资源标识符。

snapshotId?: null | string

属性值

null | string

storageToNetworkProximity

为卷的网络邻近度信息提供存储。

storageToNetworkProximity?: string

属性值

string

subnetId

委托子网的 Azure 资源 URI。 必须具有委派 Microsoft.NetApp/volumes

subnetId: string

属性值

string

t2Network

T2 网络信息

t2Network?: string

属性值

string

throughputMibps

此卷可以实现的最大吞吐量(以 MiB/s 为单位),这将仅被接受为手动 qosType 卷的输入

throughputMibps?: null | number

属性值

null | number

unixPermissions

以八进制 4 位格式接受的 NFS 卷的 UNIX 权限。 第一位数字选择设置用户 ID(4)、设置组 ID (2) 和粘滞 (1) 属性。 第二位数字选择文件所有者的权限:读取(4)、写入(2)和执行(1)。 第三个选择同一组中其他用户的权限。 第四个用户不在组中。 0755 - 向所有者提供读/写/执行权限,并向组和其他用户授予读取/执行权限。

unixPermissions?: null | string

属性值

null | string

usageThreshold

文件系统允许的最大存储配额(以字节为单位)。 这是一个仅用于警报的软配额。 对于常规卷,有效值在 50GiB 到 100TiB 之间。 对于大卷,有效值在 100TiB 到 500TiB 的范围内,在特殊情况下,从 2400GiB 到 2400TiB 不等。 对于超大卷,有效值在 2400GiB 到 7200TiB 之间。 以字节表示为 1 GiB 的倍数的值。

usageThreshold: number

属性值

number

volumeGroupName

卷组名称

volumeGroupName?: string

属性值

string

volumeSpecName

卷规格名称是卷组中特定卷的特定名称或标识符,例如数据、日志

volumeSpecName?: string

属性值

string

volumeType

这是什么类型的卷。 对于跨区域复制中的目标卷,请将类型设置为 DataProtection。 若要创建克隆卷,请将类型设置为 ShortTermClone

volumeType?: string

属性值

string