你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.NetApp netAppAccounts/capacityPools/volumes 2023-05-01
- 最新
- 2024-03-01
- 2024-03-01-preview
- 2023-11-01
- 2023-11-01-preview
- 2023-07-01
- 2023-07-01-preview
- 2023-05-01
- 2023-05-01-preview
- 2022-11-01
- 2022-11-01-preview
- 2022-09-01
- 2022-05-01
- 2022-03-01
- 2022-01-01
- 2021-10-01
- 2021-08-01
- 2021-06-01
- 2021-04-01
- 2021-04-01-preview
- 2021-02-01
- 2020-12-01
- 2020-11-01
- 2020-09-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-03-01
- 2020-02-01
- 2019-11-01
- 2019-10-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-05-01
- 2017-08-15
Bicep 资源定义
可以使用目标操作部署 netAppAccounts/capacityPools/volumes 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-05-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
avsDataStore: 'string'
backupId: 'string'
capacityPoolResourceId: 'string'
coolAccess: bool
coolAccessRetrievalPolicy: 'string'
coolnessPeriod: int
creationToken: 'string'
dataProtection: {
replication: {
endpointType: 'string'
remoteVolumeRegion: 'string'
remoteVolumeResourceId: 'string'
replicationSchedule: 'string'
}
snapshot: {
snapshotPolicyId: 'string'
}
volumeRelocation: {
relocationRequested: bool
}
}
defaultGroupQuotaInKiBs: int
defaultUserQuotaInKiBs: int
deleteBaseSnapshot: bool
enableSubvolumes: 'string'
encryptionKeySource: 'string'
exportPolicy: {
rules: [
{
allowedClients: 'string'
chownMode: 'string'
cifs: bool
hasRootAccess: bool
kerberos5iReadWrite: bool
kerberos5pReadWrite: bool
kerberos5ReadWrite: bool
nfsv3: bool
nfsv41: bool
ruleIndex: int
unixReadWrite: bool
}
]
}
isDefaultQuotaEnabled: bool
isLargeVolume: bool
isRestoring: bool
kerberosEnabled: bool
keyVaultPrivateEndpointResourceId: 'string'
ldapEnabled: bool
networkFeatures: 'string'
placementRules: [
{
key: 'string'
value: 'string'
}
]
protocolTypes: [
'string'
]
proximityPlacementGroup: 'string'
securityStyle: 'string'
serviceLevel: 'string'
smbAccessBasedEnumeration: 'string'
smbContinuouslyAvailable: bool
smbEncryption: bool
smbNonBrowsable: 'string'
snapshotDirectoryVisible: bool
snapshotId: 'string'
subnetId: 'string'
throughputMibps: int
unixPermissions: 'string'
usageThreshold: int
volumeSpecName: 'string'
volumeType: 'string'
}
zones: [
'string'
]
}
属性值
netAppAccounts/capacityPools/volumes
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源名称 了解如何在 Bicep中设置子资源的名称和类型。 |
string (必需) |
位置 | 资源所在的地理位置 | string (必需) |
标签 | 资源标记。 | 标记名称和值的字典。 请参阅模板 中的 |
父母 | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:capacityPools |
性能 | 卷属性 | VolumeProperties(必需) |
区 | 可用性区域 | string[] 约束: 最小长度 = 1 最大长度 = 255 |
VolumeProperties
名字 | 描述 | 价值 |
---|---|---|
avsDataStore | 指定是否为 Azure VMware 解决方案(AVS)数据存储目的启用卷 | “Disabled” “Enabled” |
backupId | 用于标识备份的 UUID v4 或资源标识符。 | 字符串 |
capacityPoolResourceId | 通过卷组创建卷时使用的池资源 ID | 字符串 |
coolAccess | 指定是否为卷启用冷访问(分层)。 | bool |
coolAccessRetrievalPolicy | coolAccessRetrievalPolicy 根据启用冷访问卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为: 默认值 - 数据将从冷层提取到随机读取时的标准存储。 此策略是默认值。 OnRead - 所有客户端驱动的数据读取都从冷层提取到顺序读取和随机读取的标准存储。 从不 - 没有从冷层提取到标准存储的客户端驱动数据。 |
“Default” “永不” “OnRead” |
coolnessPeriod | 指定客户端不访问的数据分层后的天数。 | int 约束: 最小值 = 7 最大值 = 63 |
creationToken | 卷的唯一文件路径。 创建装载目标时使用 | string (必需) 约束: 最小长度 = 1 最大长度 = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ |
dataProtection | DataProtection 类型卷包含包含复制详细信息的对象 | VolumePropertiesDataProtection |
defaultGroupQuotaInKiBs | 卷的默认组配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiBs。 | int |
defaultUserQuotaInKiBs | 卷的默认用户配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KIB。 | int |
deleteBaseSnapshot | 如果启用(true),则卷创建的快照将在卷创建操作完成后自动删除。 默认值为 false | bool |
enableSubvolumes | 指示是否在卷上启用子卷操作的标志 | “Disabled” “Enabled” |
encryptionKeySource | 用于加密卷中数据的密钥源。 如果 NetApp 帐户具有 encryption.keySource = “Microsoft.KeyVault”,则适用。 可能的值(不区分大小写)是:“Microsoft.NetApp,Microsoft.KeyVault” | “Microsoft.KeyVault” “Microsoft.NetApp” |
exportPolicy | 导出策略规则集 | VolumePropertiesExportPolicy |
isDefaultQuotaEnabled | 指定是否为卷启用了默认配额。 | bool |
isLargeVolume | 指定卷是大型卷还是常规卷。 | bool |
isRestoring | 恢复 | bool |
kerberosEnabled | 描述卷是否为 KerberosEnabled。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
keyVaultPrivateEndpointResourceId | KeyVault 的专用终结点的资源 ID。 它必须与卷位于同一 VNET 中。 仅当 encryptionKeySource = 'Microsoft.KeyVault' 时才适用。 | 字符串 |
ldapEnabled | 指定是否为给定 NFS 卷启用 LDAP。 | bool |
networkFeatures | 可用于卷或当前更新状态的网络功能。 | “Basic” “Basic_Standard” “Standard” “Standard_Basic” |
placementRules | 特定卷的应用程序特定放置规则 | PlacementKeyValuePairs[] |
protocolTypes | 协议类型集、默认 NFSv3、SMB 协议的 CIFS | string[] |
proximityPlacementGroup | 与卷关联的邻近放置组 | 字符串 |
securityStyle | 卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议) | “ntfs” “unix” |
serviceLevel | 文件系统的服务级别 | “Premium” “Standard” “StandardZRS” “Ultra” |
smbAccessBasedEnumeration | 为 SMB 共享启用基于访问的枚举共享属性。 仅适用于 SMB/DualProtocol 卷 | “Disabled” “Enabled” |
smbContinuouslyAvailable | 为 smb 卷启用连续可用的共享属性。 仅适用于 SMB 卷 | bool |
smbEncryption | 为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用 | bool |
smbNonBrowsable | 为 SMB 共享启用不可浏览的属性。 仅适用于 SMB/DualProtocol 卷 | “Disabled” “Enabled” |
snapshotDirectoryVisible | 如果启用(true),卷将包含只读快照目录,该目录提供对每个卷快照的访问权限(默认值为 true)。 | bool |
snapshotId | 用于标识快照的 UUID v4 或资源标识符。 | 字符串 |
subnetId | 委托子网的 Azure 资源 URI。 必须具有委派Microsoft.NetApp/volumes | string (必需) |
throughputMibps | MiB/s 中可实现的最大吞吐量,此卷仅接受为手动 qosType 卷的输入 | int |
unixPermissions | 以八进制 4 位格式接受的 NFS 卷的 UNIX 权限。 第一位数字选择设置用户 ID(4)、设置组 ID (2) 和粘滞 (1) 属性。 第二位数字选择文件所有者的权限:读取(4)、写入(2)和执行(1)。 第三个选择同一组中其他用户的权限。 第四个用户不在组中。 0755 - 向所有者提供读/写/执行权限,并向组和其他用户授予读取/执行权限。 | 字符串 约束: 最小长度 = 4 最大长度 = 4 |
usageThreshold | 文件系统允许的最大存储配额(以字节为单位)。 这是仅用于警报的软配额。 最小大小为 100 GiB。 上限为 100TiB、500Tib(适用于 LargeVolume)或 2400Tib(对于 LargeVolume)(异常)。 以字节为单位指定。 | int (必需) 约束: 最小值 = 107374182400 最大值 = 2638827906662400 |
volumeSpecName | 卷规格名称是卷组中特定卷的应用程序特定指定或标识符,例如数据、日志 | 字符串 |
volumeType | 卷的类型是这样的。 对于跨区域复制中的目标卷,请将类型设置为 DataProtection | 字符串 |
VolumePropertiesDataProtection
名字 | 描述 | 价值 |
---|---|---|
复制 | 复制属性 | ReplicationObject |
快照 | 快照属性。 | VolumeSnapshotProperties |
volumeRelocation | VolumeRelocation 属性 | VolumeRelocationProperties |
ReplicationObject
名字 | 描述 | 价值 |
---|---|---|
endpointType | 指示本地卷是卷复制的源还是目标 | “dst” 'src' |
remoteVolumeRegion | 卷复制另一端的远程区域。 | 字符串 |
remoteVolumeResourceId | 远程卷的资源 ID。 | string (必需) |
replicationSchedule | 附表 | “_10minutely” “daily” “hourly” |
VolumeSnapshotProperties
名字 | 描述 | 价值 |
---|---|---|
snapshotPolicyId | 快照策略 ResourceId | 字符串 |
VolumeRelocationProperties
名字 | 描述 | 价值 |
---|---|---|
relocationRequested | 是否已为此卷请求重定位 | bool |
VolumePropertiesExportPolicy
名字 | 描述 | 价值 |
---|---|---|
规则 | 导出策略规则 | ExportPolicyRule[] |
ExportPolicyRule
名字 | 描述 | 价值 |
---|---|---|
allowedClients | 客户端入口规范为逗号分隔字符串,带有 IPv4CIDR、IPv4 主机地址和主机名 | 字符串 |
chownMode | 此参数指定有权更改文件的所有权的人员。 受限 - 只有根用户可以更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。 | “受限” “不受限制” |
cifs | 允许 CIFS 协议 | bool |
hasRootAccess | 对卷具有根访问权限 | bool |
kerberos5iReadWrite | Kerberos5i 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
kerberos5pReadWrite | Kerberos5p 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
kerberos5ReadWrite | Kerberos5 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
nfsv3 | 允许 NFSv3 协议。 仅对 NFSv3 类型卷启用 | bool |
nfsv41 | 允许 NFSv4.1 协议。 仅对 NFSv4.1 类型卷启用 | bool |
ruleIndex | 订单索引 | int |
unixReadWrite | 读取和写入访问权限 | bool |
PlacementKeyValuePairs
名字 | 描述 | 价值 |
---|---|---|
钥匙 | 卷组中卷放置的应用程序特定参数的键 | string (必需) |
价值 | 卷组中卷放置的应用程序特定参数的值 | string (必需) |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
使用 NFSV3/NFSv4.1 卷创建新的 ANF 资源 |
使用此模板,可以使用单个容量池和配置了 NFSV3 或 NFSv4.1 协议的单个卷创建新的 Azure NetApp 文件资源。 它们都与要创建的任何卷所需的 Azure 虚拟网络和委派子网一起部署 |
使用 SMB 卷 创建新的 ANF 资源 |
使用此模板,可以使用单个容量池和配置 SMB 协议的单个卷创建新的 Azure NetApp 文件资源。 |
ARM 模板资源定义
可以使用目标操作部署 netAppAccounts/capacityPools/volumes 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
"apiVersion": "2023-05-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"avsDataStore": "string",
"backupId": "string",
"capacityPoolResourceId": "string",
"coolAccess": "bool",
"coolAccessRetrievalPolicy": "string",
"coolnessPeriod": "int",
"creationToken": "string",
"dataProtection": {
"replication": {
"endpointType": "string",
"remoteVolumeRegion": "string",
"remoteVolumeResourceId": "string",
"replicationSchedule": "string"
},
"snapshot": {
"snapshotPolicyId": "string"
},
"volumeRelocation": {
"relocationRequested": "bool"
}
},
"defaultGroupQuotaInKiBs": "int",
"defaultUserQuotaInKiBs": "int",
"deleteBaseSnapshot": "bool",
"enableSubvolumes": "string",
"encryptionKeySource": "string",
"exportPolicy": {
"rules": [
{
"allowedClients": "string",
"chownMode": "string",
"cifs": "bool",
"hasRootAccess": "bool",
"kerberos5iReadWrite": "bool",
"kerberos5pReadWrite": "bool",
"kerberos5ReadWrite": "bool",
"nfsv3": "bool",
"nfsv41": "bool",
"ruleIndex": "int",
"unixReadWrite": "bool"
}
]
},
"isDefaultQuotaEnabled": "bool",
"isLargeVolume": "bool",
"isRestoring": "bool",
"kerberosEnabled": "bool",
"keyVaultPrivateEndpointResourceId": "string",
"ldapEnabled": "bool",
"networkFeatures": "string",
"placementRules": [
{
"key": "string",
"value": "string"
}
],
"protocolTypes": [ "string" ],
"proximityPlacementGroup": "string",
"securityStyle": "string",
"serviceLevel": "string",
"smbAccessBasedEnumeration": "string",
"smbContinuouslyAvailable": "bool",
"smbEncryption": "bool",
"smbNonBrowsable": "string",
"snapshotDirectoryVisible": "bool",
"snapshotId": "string",
"subnetId": "string",
"throughputMibps": "int",
"unixPermissions": "string",
"usageThreshold": "int",
"volumeSpecName": "string",
"volumeType": "string"
},
"zones": [ "string" ]
}
属性值
netAppAccounts/capacityPools/volumes
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.NetApp/netAppAccounts/capacityPools/volumes” |
apiVersion | 资源 API 版本 | '2023-05-01' |
名字 | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
string (必需) |
位置 | 资源所在的地理位置 | string (必需) |
标签 | 资源标记。 | 标记名称和值的字典。 请参阅模板 中的 |
性能 | 卷属性 | VolumeProperties(必需) |
区 | 可用性区域 | string[] 约束: 最小长度 = 1 最大长度 = 255 |
VolumeProperties
名字 | 描述 | 价值 |
---|---|---|
avsDataStore | 指定是否为 Azure VMware 解决方案(AVS)数据存储目的启用卷 | “Disabled” “Enabled” |
backupId | 用于标识备份的 UUID v4 或资源标识符。 | 字符串 |
capacityPoolResourceId | 通过卷组创建卷时使用的池资源 ID | 字符串 |
coolAccess | 指定是否为卷启用冷访问(分层)。 | bool |
coolAccessRetrievalPolicy | coolAccessRetrievalPolicy 根据启用冷访问卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为: 默认值 - 数据将从冷层提取到随机读取时的标准存储。 此策略是默认值。 OnRead - 所有客户端驱动的数据读取都从冷层提取到顺序读取和随机读取的标准存储。 从不 - 没有从冷层提取到标准存储的客户端驱动数据。 |
“Default” “永不” “OnRead” |
coolnessPeriod | 指定客户端不访问的数据分层后的天数。 | int 约束: 最小值 = 7 最大值 = 63 |
creationToken | 卷的唯一文件路径。 创建装载目标时使用 | string (必需) 约束: 最小长度 = 1 最大长度 = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ |
dataProtection | DataProtection 类型卷包含包含复制详细信息的对象 | VolumePropertiesDataProtection |
defaultGroupQuotaInKiBs | 卷的默认组配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiBs。 | int |
defaultUserQuotaInKiBs | 卷的默认用户配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KIB。 | int |
deleteBaseSnapshot | 如果启用(true),则卷创建的快照将在卷创建操作完成后自动删除。 默认值为 false | bool |
enableSubvolumes | 指示是否在卷上启用子卷操作的标志 | “Disabled” “Enabled” |
encryptionKeySource | 用于加密卷中数据的密钥源。 如果 NetApp 帐户具有 encryption.keySource = “Microsoft.KeyVault”,则适用。 可能的值(不区分大小写)是:“Microsoft.NetApp,Microsoft.KeyVault” | “Microsoft.KeyVault” “Microsoft.NetApp” |
exportPolicy | 导出策略规则集 | VolumePropertiesExportPolicy |
isDefaultQuotaEnabled | 指定是否为卷启用了默认配额。 | bool |
isLargeVolume | 指定卷是大型卷还是常规卷。 | bool |
isRestoring | 恢复 | bool |
kerberosEnabled | 描述卷是否为 KerberosEnabled。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
keyVaultPrivateEndpointResourceId | KeyVault 的专用终结点的资源 ID。 它必须与卷位于同一 VNET 中。 仅当 encryptionKeySource = 'Microsoft.KeyVault' 时才适用。 | 字符串 |
ldapEnabled | 指定是否为给定 NFS 卷启用 LDAP。 | bool |
networkFeatures | 可用于卷或当前更新状态的网络功能。 | “Basic” “Basic_Standard” “Standard” “Standard_Basic” |
placementRules | 特定卷的应用程序特定放置规则 | PlacementKeyValuePairs[] |
protocolTypes | 协议类型集、默认 NFSv3、SMB 协议的 CIFS | string[] |
proximityPlacementGroup | 与卷关联的邻近放置组 | 字符串 |
securityStyle | 卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议) | “ntfs” “unix” |
serviceLevel | 文件系统的服务级别 | “Premium” “Standard” “StandardZRS” “Ultra” |
smbAccessBasedEnumeration | 为 SMB 共享启用基于访问的枚举共享属性。 仅适用于 SMB/DualProtocol 卷 | “Disabled” “Enabled” |
smbContinuouslyAvailable | 为 smb 卷启用连续可用的共享属性。 仅适用于 SMB 卷 | bool |
smbEncryption | 为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用 | bool |
smbNonBrowsable | 为 SMB 共享启用不可浏览的属性。 仅适用于 SMB/DualProtocol 卷 | “Disabled” “Enabled” |
snapshotDirectoryVisible | 如果启用(true),卷将包含只读快照目录,该目录提供对每个卷快照的访问权限(默认值为 true)。 | bool |
snapshotId | 用于标识快照的 UUID v4 或资源标识符。 | 字符串 |
subnetId | 委托子网的 Azure 资源 URI。 必须具有委派Microsoft.NetApp/volumes | string (必需) |
throughputMibps | MiB/s 中可实现的最大吞吐量,此卷仅接受为手动 qosType 卷的输入 | int |
unixPermissions | 以八进制 4 位格式接受的 NFS 卷的 UNIX 权限。 第一位数字选择设置用户 ID(4)、设置组 ID (2) 和粘滞 (1) 属性。 第二位数字选择文件所有者的权限:读取(4)、写入(2)和执行(1)。 第三个选择同一组中其他用户的权限。 第四个用户不在组中。 0755 - 向所有者提供读/写/执行权限,并向组和其他用户授予读取/执行权限。 | 字符串 约束: 最小长度 = 4 最大长度 = 4 |
usageThreshold | 文件系统允许的最大存储配额(以字节为单位)。 这是仅用于警报的软配额。 最小大小为 100 GiB。 上限为 100TiB、500Tib(适用于 LargeVolume)或 2400Tib(对于 LargeVolume)(异常)。 以字节为单位指定。 | int (必需) 约束: 最小值 = 107374182400 最大值 = 2638827906662400 |
volumeSpecName | 卷规格名称是卷组中特定卷的应用程序特定指定或标识符,例如数据、日志 | 字符串 |
volumeType | 卷的类型是这样的。 对于跨区域复制中的目标卷,请将类型设置为 DataProtection | 字符串 |
VolumePropertiesDataProtection
名字 | 描述 | 价值 |
---|---|---|
复制 | 复制属性 | ReplicationObject |
快照 | 快照属性。 | VolumeSnapshotProperties |
volumeRelocation | VolumeRelocation 属性 | VolumeRelocationProperties |
ReplicationObject
名字 | 描述 | 价值 |
---|---|---|
endpointType | 指示本地卷是卷复制的源还是目标 | “dst” 'src' |
remoteVolumeRegion | 卷复制另一端的远程区域。 | 字符串 |
remoteVolumeResourceId | 远程卷的资源 ID。 | string (必需) |
replicationSchedule | 附表 | “_10minutely” “daily” “hourly” |
VolumeSnapshotProperties
名字 | 描述 | 价值 |
---|---|---|
snapshotPolicyId | 快照策略 ResourceId | 字符串 |
VolumeRelocationProperties
名字 | 描述 | 价值 |
---|---|---|
relocationRequested | 是否已为此卷请求重定位 | bool |
VolumePropertiesExportPolicy
名字 | 描述 | 价值 |
---|---|---|
规则 | 导出策略规则 | ExportPolicyRule[] |
ExportPolicyRule
名字 | 描述 | 价值 |
---|---|---|
allowedClients | 客户端入口规范为逗号分隔字符串,带有 IPv4CIDR、IPv4 主机地址和主机名 | 字符串 |
chownMode | 此参数指定有权更改文件的所有权的人员。 受限 - 只有根用户可以更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。 | “受限” “不受限制” |
cifs | 允许 CIFS 协议 | bool |
hasRootAccess | 对卷具有根访问权限 | bool |
kerberos5iReadWrite | Kerberos5i 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
kerberos5pReadWrite | Kerberos5p 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
kerberos5ReadWrite | Kerberos5 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
nfsv3 | 允许 NFSv3 协议。 仅对 NFSv3 类型卷启用 | bool |
nfsv41 | 允许 NFSv4.1 协议。 仅对 NFSv4.1 类型卷启用 | bool |
ruleIndex | 订单索引 | int |
unixReadWrite | 读取和写入访问权限 | bool |
PlacementKeyValuePairs
名字 | 描述 | 价值 |
---|---|---|
钥匙 | 卷组中卷放置的应用程序特定参数的键 | string (必需) |
价值 | 卷组中卷放置的应用程序特定参数的值 | string (必需) |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
使用 NFSV3/NFSv4.1 卷创建新的 ANF 资源 |
使用此模板,可以使用单个容量池和配置了 NFSV3 或 NFSv4.1 协议的单个卷创建新的 Azure NetApp 文件资源。 它们都与要创建的任何卷所需的 Azure 虚拟网络和委派子网一起部署 |
使用 SMB 卷 创建新的 ANF 资源 |
使用此模板,可以使用单个容量池和配置 SMB 协议的单个卷创建新的 Azure NetApp 文件资源。 |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 netAppAccounts/capacityPools/volumes 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-05-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
avsDataStore = "string"
backupId = "string"
capacityPoolResourceId = "string"
coolAccess = bool
coolAccessRetrievalPolicy = "string"
coolnessPeriod = int
creationToken = "string"
dataProtection = {
replication = {
endpointType = "string"
remoteVolumeRegion = "string"
remoteVolumeResourceId = "string"
replicationSchedule = "string"
}
snapshot = {
snapshotPolicyId = "string"
}
volumeRelocation = {
relocationRequested = bool
}
}
defaultGroupQuotaInKiBs = int
defaultUserQuotaInKiBs = int
deleteBaseSnapshot = bool
enableSubvolumes = "string"
encryptionKeySource = "string"
exportPolicy = {
rules = [
{
allowedClients = "string"
chownMode = "string"
cifs = bool
hasRootAccess = bool
kerberos5iReadWrite = bool
kerberos5pReadWrite = bool
kerberos5ReadWrite = bool
nfsv3 = bool
nfsv41 = bool
ruleIndex = int
unixReadWrite = bool
}
]
}
isDefaultQuotaEnabled = bool
isLargeVolume = bool
isRestoring = bool
kerberosEnabled = bool
keyVaultPrivateEndpointResourceId = "string"
ldapEnabled = bool
networkFeatures = "string"
placementRules = [
{
key = "string"
value = "string"
}
]
protocolTypes = [
"string"
]
proximityPlacementGroup = "string"
securityStyle = "string"
serviceLevel = "string"
smbAccessBasedEnumeration = "string"
smbContinuouslyAvailable = bool
smbEncryption = bool
smbNonBrowsable = "string"
snapshotDirectoryVisible = bool
snapshotId = "string"
subnetId = "string"
throughputMibps = int
unixPermissions = "string"
usageThreshold = int
volumeSpecName = "string"
volumeType = "string"
}
zones = [
"string"
]
})
}
属性值
netAppAccounts/capacityPools/volumes
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-05-01” |
名字 | 资源名称 | string (必需) |
位置 | 资源所在的地理位置 | string (必需) |
parent_id | 此资源的父资源的 ID。 | 类型资源的 ID:capacityPools |
标签 | 资源标记。 | 标记名称和值的字典。 |
性能 | 卷属性 | VolumeProperties(必需) |
区 | 可用性区域 | string[] 约束: 最小长度 = 1 最大长度 = 255 |
VolumeProperties
名字 | 描述 | 价值 |
---|---|---|
avsDataStore | 指定是否为 Azure VMware 解决方案(AVS)数据存储目的启用卷 | “Disabled” “已启用” |
backupId | 用于标识备份的 UUID v4 或资源标识符。 | 字符串 |
capacityPoolResourceId | 通过卷组创建卷时使用的池资源 ID | 字符串 |
coolAccess | 指定是否为卷启用冷访问(分层)。 | bool |
coolAccessRetrievalPolicy | coolAccessRetrievalPolicy 根据启用冷访问卷的读取模式确定从冷层到标准存储的数据检索行为。 此字段的可能值为: 默认值 - 数据将从冷层提取到随机读取时的标准存储。 此策略是默认值。 OnRead - 所有客户端驱动的数据读取都从冷层提取到顺序读取和随机读取的标准存储。 从不 - 没有从冷层提取到标准存储的客户端驱动数据。 |
“Default” “永不” “OnRead” |
coolnessPeriod | 指定客户端不访问的数据分层后的天数。 | int 约束: 最小值 = 7 最大值 = 63 |
creationToken | 卷的唯一文件路径。 创建装载目标时使用 | string (必需) 约束: 最小长度 = 1 最大长度 = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ |
dataProtection | DataProtection 类型卷包含包含复制详细信息的对象 | VolumePropertiesDataProtection |
defaultGroupQuotaInKiBs | 卷的默认组配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KiBs。 | int |
defaultUserQuotaInKiBs | 卷的默认用户配额(以 KIB 为单位)。 如果设置了 isDefaultQuotaEnabled,则应用最小值 4 KIB。 | int |
deleteBaseSnapshot | 如果启用(true),则卷创建的快照将在卷创建操作完成后自动删除。 默认值为 false | bool |
enableSubvolumes | 指示是否在卷上启用子卷操作的标志 | “Disabled” “已启用” |
encryptionKeySource | 用于加密卷中数据的密钥源。 如果 NetApp 帐户具有 encryption.keySource = “Microsoft.KeyVault”,则适用。 可能的值(不区分大小写)是:“Microsoft.NetApp,Microsoft.KeyVault” | “Microsoft.KeyVault” “Microsoft.NetApp” |
exportPolicy | 导出策略规则集 | VolumePropertiesExportPolicy |
isDefaultQuotaEnabled | 指定是否为卷启用了默认配额。 | bool |
isLargeVolume | 指定卷是大型卷还是常规卷。 | bool |
isRestoring | 恢复 | bool |
kerberosEnabled | 描述卷是否为 KerberosEnabled。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
keyVaultPrivateEndpointResourceId | KeyVault 的专用终结点的资源 ID。 它必须与卷位于同一 VNET 中。 仅当 encryptionKeySource = 'Microsoft.KeyVault' 时才适用。 | 字符串 |
ldapEnabled | 指定是否为给定 NFS 卷启用 LDAP。 | bool |
networkFeatures | 可用于卷或当前更新状态的网络功能。 | “Basic” “Basic_Standard” “Standard” “Standard_Basic” |
placementRules | 特定卷的应用程序特定放置规则 | PlacementKeyValuePairs[] |
protocolTypes | 协议类型集、默认 NFSv3、SMB 协议的 CIFS | string[] |
proximityPlacementGroup | 与卷关联的邻近放置组 | 字符串 |
securityStyle | 卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议) | “ntfs” “unix” |
serviceLevel | 文件系统的服务级别 | “Premium” “Standard” “StandardZRS” “Ultra” |
smbAccessBasedEnumeration | 为 SMB 共享启用基于访问的枚举共享属性。 仅适用于 SMB/DualProtocol 卷 | “Disabled” “已启用” |
smbContinuouslyAvailable | 为 smb 卷启用连续可用的共享属性。 仅适用于 SMB 卷 | bool |
smbEncryption | 为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用 | bool |
smbNonBrowsable | 为 SMB 共享启用不可浏览的属性。 仅适用于 SMB/DualProtocol 卷 | “Disabled” “已启用” |
snapshotDirectoryVisible | 如果启用(true),卷将包含只读快照目录,该目录提供对每个卷快照的访问权限(默认值为 true)。 | bool |
snapshotId | 用于标识快照的 UUID v4 或资源标识符。 | 字符串 |
subnetId | 委托子网的 Azure 资源 URI。 必须具有委派Microsoft.NetApp/volumes | string (必需) |
throughputMibps | MiB/s 中可实现的最大吞吐量,此卷仅接受为手动 qosType 卷的输入 | int |
unixPermissions | 以八进制 4 位格式接受的 NFS 卷的 UNIX 权限。 第一位数字选择设置用户 ID(4)、设置组 ID (2) 和粘滞 (1) 属性。 第二位数字选择文件所有者的权限:读取(4)、写入(2)和执行(1)。 第三个选择同一组中其他用户的权限。 第四个用户不在组中。 0755 - 向所有者提供读/写/执行权限,并向组和其他用户授予读取/执行权限。 | 字符串 约束: 最小长度 = 4 最大长度 = 4 |
usageThreshold | 文件系统允许的最大存储配额(以字节为单位)。 这是仅用于警报的软配额。 最小大小为 100 GiB。 上限为 100TiB、500Tib(适用于 LargeVolume)或 2400Tib(对于 LargeVolume)(异常)。 以字节为单位指定。 | int (必需) 约束: 最小值 = 107374182400 最大值 = 2638827906662400 |
volumeSpecName | 卷规格名称是卷组中特定卷的应用程序特定指定或标识符,例如数据、日志 | 字符串 |
volumeType | 卷的类型是这样的。 对于跨区域复制中的目标卷,请将类型设置为 DataProtection | 字符串 |
VolumePropertiesDataProtection
名字 | 描述 | 价值 |
---|---|---|
复制 | 复制属性 | ReplicationObject |
快照 | 快照属性。 | VolumeSnapshotProperties |
volumeRelocation | VolumeRelocation 属性 | VolumeRelocationProperties |
ReplicationObject
名字 | 描述 | 价值 |
---|---|---|
endpointType | 指示本地卷是卷复制的源还是目标 | “dst” “src” |
remoteVolumeRegion | 卷复制另一端的远程区域。 | 字符串 |
remoteVolumeResourceId | 远程卷的资源 ID。 | string (必需) |
replicationSchedule | 附表 | “_10minutely” “daily” “hourly” |
VolumeSnapshotProperties
名字 | 描述 | 价值 |
---|---|---|
snapshotPolicyId | 快照策略 ResourceId | 字符串 |
VolumeRelocationProperties
名字 | 描述 | 价值 |
---|---|---|
relocationRequested | 是否已为此卷请求重定位 | bool |
VolumePropertiesExportPolicy
名字 | 描述 | 价值 |
---|---|---|
规则 | 导出策略规则 | ExportPolicyRule[] |
ExportPolicyRule
名字 | 描述 | 价值 |
---|---|---|
allowedClients | 客户端入口规范为逗号分隔字符串,带有 IPv4CIDR、IPv4 主机地址和主机名 | 字符串 |
chownMode | 此参数指定有权更改文件的所有权的人员。 受限 - 只有根用户可以更改文件的所有权。 不受限制 - 非根用户可以更改其拥有的文件的所有权。 | “受限” “不受限制” |
cifs | 允许 CIFS 协议 | bool |
hasRootAccess | 对卷具有根访问权限 | bool |
kerberos5iReadWrite | Kerberos5i 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
kerberos5pReadWrite | Kerberos5p 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
kerberos5ReadWrite | Kerberos5 读取和写入访问权限。 与 swagger 版本 2020-05-01 或更高版本一起使用 | bool |
nfsv3 | 允许 NFSv3 协议。 仅对 NFSv3 类型卷启用 | bool |
nfsv41 | 允许 NFSv4.1 协议。 仅对 NFSv4.1 类型卷启用 | bool |
ruleIndex | 订单索引 | int |
unixReadWrite | 读取和写入访问权限 | bool |
PlacementKeyValuePairs
名字 | 描述 | 价值 |
---|---|---|
钥匙 | 卷组中卷放置的应用程序特定参数的键 | string (必需) |
价值 | 卷组中卷放置的应用程序特定参数的值 | string (必需) |