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

Microsoft.NetApp netAppAccounts/capacityPools/volumes 2021-04-01-preview

Bicep 资源定义

可以使用目标操作部署 netAppAccounts/capacityPools/volumes 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    backupId: 'string'
    creationToken: 'string'
    dataProtection: {
      backup: {
        backupEnabled: bool
        backupPolicyId: 'string'
        policyEnforced: bool
        vaultId: 'string'
      }
      replication: {
        endpointType: 'string'
        remoteVolumeRegion: 'string'
        remoteVolumeResourceId: 'string'
        replicationId: 'string'
        replicationSchedule: 'string'
      }
      snapshot: {
        snapshotPolicyId: 'string'
      }
    }
    encryptionKeySource: 'string'
    exportPolicy: {
      rules: [
        {
          allowedClients: 'string'
          cifs: bool
          hasRootAccess: bool
          kerberos5iReadWrite: bool
          kerberos5pReadWrite: bool
          kerberos5ReadWrite: bool
          nfsv3: bool
          nfsv41: bool
          ruleIndex: int
          unixReadWrite: bool
        }
      ]
    }
    isRestoring: bool
    kerberosEnabled: bool
    ldapEnabled: bool
    networkFeatures: 'string'
    protocolTypes: [
      'string'
    ]
    securityStyle: 'string'
    serviceLevel: 'string'
    smbContinuouslyAvailable: bool
    smbEncryption: bool
    snapshotDirectoryVisible: bool
    snapshotId: 'string'
    subnetId: 'string'
    throughputMibps: int
    usageThreshold: int
    volumeType: 'string'
  }
}

属性值

netAppAccounts/capacityPools/volumes

名字 描述 价值
名字 资源名称

了解如何在 Bicep中设置子资源的名称和类型。
string (必需)
位置 资源位置 string (必需)
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:capacityPools
性能 卷属性 VolumeProperties(必需)

VolumeProperties

名字 描述 价值
backupId 用于标识备份的 UUID v4 或资源标识符。 字符串

约束:
最小长度 = 36
最大长度 = 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}|(\\?([^\/]*[\/])*)([^\/]+)$
creationToken 卷的唯一文件路径。 创建装载目标时使用 string (必需)

约束:
最小长度 = 1
最大长度 = 80
Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$
dataProtection DataProtection 类型卷包含包含复制详细信息的对象 VolumePropertiesDataProtection
encryptionKeySource 加密密钥源。 可能的值为:“Microsoft.NetApp” 字符串
exportPolicy 导出策略规则集 VolumePropertiesExportPolicy
isRestoring 恢复 bool
kerberosEnabled 描述卷是否为 KerberosEnabled。 与 swagger 版本 2020-05-01 或更高版本一起使用 bool
ldapEnabled 指定是否为给定 NFS 卷启用 LDAP。 bool
networkFeatures 卷可用的基本网络或标准功能。 “Basic”
“Standard”
protocolTypes 协议类型集、默认 NFSv3、SMB 协议的 CIFS string[]
securityStyle 卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议) “ntfs”
“unix”
serviceLevel 文件系统的服务级别 “Premium”
“Standard”
“Ultra”
smbContinuouslyAvailable 为 smb 卷启用连续可用的共享属性。 仅适用于 SMB 卷 bool
smbEncryption 为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用 bool
snapshotDirectoryVisible 如果启用(true),卷将包含只读快照目录,该目录提供对每个卷快照的访问权限(默认为 true)。 bool
snapshotId 用于标识快照的 UUID v4 或资源标识符。 字符串

约束:
最小长度 = 36
最大长度 = 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}|(\\?([^\/]*[\/])*)([^\/]+)$
subnetId 委托子网的 Azure 资源 URI。 必须具有委派Microsoft.NetApp/volumes string (必需)
throughputMibps Mibps 中可通过此卷实现的最大吞吐量 int

约束:
最小值 = 0
最大值 = 4500
usageThreshold 文件系统允许的最大存储配额(以字节为单位)。 这是仅用于警报的软配额。 最小大小为 100 GiB。 上限为 100TiB。 以字节为单位指定。 int (必需)

约束:
最小值 = 107374182400
最大值 = 109951162777600
volumeType 卷的类型是什么 字符串

VolumePropertiesDataProtection

名字 描述 价值
备份 备份属性 VolumeBackupProperties
复制 复制属性 ReplicationObject
快照 快照属性。 VolumeSnapshotProperties

VolumeBackupProperties

名字 描述 价值
backupEnabled 备份已启用 bool
backupPolicyId 备份策略资源 ID 字符串
policyEnforced 策略强制实施 bool
vaultId 保管库资源 ID 字符串

ReplicationObject

名字 描述 价值
endpointType 指示本地卷是卷复制的源还是目标 “dst”
'src'
remoteVolumeRegion 卷复制另一端的远程区域。 字符串
remoteVolumeResourceId 远程卷的资源 ID。 string (必需)
replicationId Id 字符串
replicationSchedule 附表 “_10minutely”
“daily”
“hourly”(必需)

VolumeSnapshotProperties

名字 描述 价值
snapshotPolicyId 快照策略 ResourceId 字符串

VolumePropertiesExportPolicy

名字 描述 价值
规则 导出策略规则 ExportPolicyRule[]

ExportPolicyRule

名字 描述 价值
allowedClients 客户端入口规范为逗号分隔字符串,带有 IPv4CIDR、IPv4 主机地址和主机名 字符串
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

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用 NFSV3/NFSv4.1 卷创建新的 ANF 资源

部署到 Azure
使用此模板,可以使用单个容量池和配置了 NFSV3 或 NFSv4.1 协议的单个卷创建新的 Azure NetApp 文件资源。 它们都与要创建的任何卷所需的 Azure 虚拟网络和委派子网一起部署
使用 SMB 卷 创建新的 ANF 资源

部署到 Azure
使用此模板,可以使用单个容量池和配置 SMB 协议的单个卷创建新的 Azure NetApp 文件资源。

ARM 模板资源定义

可以使用目标操作部署 netAppAccounts/capacityPools/volumes 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "backupId": "string",
    "creationToken": "string",
    "dataProtection": {
      "backup": {
        "backupEnabled": "bool",
        "backupPolicyId": "string",
        "policyEnforced": "bool",
        "vaultId": "string"
      },
      "replication": {
        "endpointType": "string",
        "remoteVolumeRegion": "string",
        "remoteVolumeResourceId": "string",
        "replicationId": "string",
        "replicationSchedule": "string"
      },
      "snapshot": {
        "snapshotPolicyId": "string"
      }
    },
    "encryptionKeySource": "string",
    "exportPolicy": {
      "rules": [
        {
          "allowedClients": "string",
          "cifs": "bool",
          "hasRootAccess": "bool",
          "kerberos5iReadWrite": "bool",
          "kerberos5pReadWrite": "bool",
          "kerberos5ReadWrite": "bool",
          "nfsv3": "bool",
          "nfsv41": "bool",
          "ruleIndex": "int",
          "unixReadWrite": "bool"
        }
      ]
    },
    "isRestoring": "bool",
    "kerberosEnabled": "bool",
    "ldapEnabled": "bool",
    "networkFeatures": "string",
    "protocolTypes": [ "string" ],
    "securityStyle": "string",
    "serviceLevel": "string",
    "smbContinuouslyAvailable": "bool",
    "smbEncryption": "bool",
    "snapshotDirectoryVisible": "bool",
    "snapshotId": "string",
    "subnetId": "string",
    "throughputMibps": "int",
    "usageThreshold": "int",
    "volumeType": "string"
  }
}

属性值

netAppAccounts/capacityPools/volumes

名字 描述 价值
类型 资源类型 “Microsoft.NetApp/netAppAccounts/capacityPools/volumes”
apiVersion 资源 API 版本 '2021-04-01-preview'
名字 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
string (必需)
位置 资源位置 string (必需)
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
性能 卷属性 VolumeProperties(必需)

VolumeProperties

名字 描述 价值
backupId 用于标识备份的 UUID v4 或资源标识符。 字符串

约束:
最小长度 = 36
最大长度 = 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}|(\\?([^\/]*[\/])*)([^\/]+)$
creationToken 卷的唯一文件路径。 创建装载目标时使用 string (必需)

约束:
最小长度 = 1
最大长度 = 80
Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$
dataProtection DataProtection 类型卷包含包含复制详细信息的对象 VolumePropertiesDataProtection
encryptionKeySource 加密密钥源。 可能的值为:“Microsoft.NetApp” 字符串
exportPolicy 导出策略规则集 VolumePropertiesExportPolicy
isRestoring 恢复 bool
kerberosEnabled 描述卷是否为 KerberosEnabled。 与 swagger 版本 2020-05-01 或更高版本一起使用 bool
ldapEnabled 指定是否为给定 NFS 卷启用 LDAP。 bool
networkFeatures 卷可用的基本网络或标准功能。 “Basic”
“Standard”
protocolTypes 协议类型集、默认 NFSv3、SMB 协议的 CIFS string[]
securityStyle 卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议) “ntfs”
“unix”
serviceLevel 文件系统的服务级别 “Premium”
“Standard”
“Ultra”
smbContinuouslyAvailable 为 smb 卷启用连续可用的共享属性。 仅适用于 SMB 卷 bool
smbEncryption 为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用 bool
snapshotDirectoryVisible 如果启用(true),卷将包含只读快照目录,该目录提供对每个卷快照的访问权限(默认为 true)。 bool
snapshotId 用于标识快照的 UUID v4 或资源标识符。 字符串

约束:
最小长度 = 36
最大长度 = 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}|(\\?([^\/]*[\/])*)([^\/]+)$
subnetId 委托子网的 Azure 资源 URI。 必须具有委派Microsoft.NetApp/volumes string (必需)
throughputMibps Mibps 中可通过此卷实现的最大吞吐量 int

约束:
最小值 = 0
最大值 = 4500
usageThreshold 文件系统允许的最大存储配额(以字节为单位)。 这是仅用于警报的软配额。 最小大小为 100 GiB。 上限为 100TiB。 以字节为单位指定。 int (必需)

约束:
最小值 = 107374182400
最大值 = 109951162777600
volumeType 卷的类型是什么 字符串

VolumePropertiesDataProtection

名字 描述 价值
备份 备份属性 VolumeBackupProperties
复制 复制属性 ReplicationObject
快照 快照属性。 VolumeSnapshotProperties

VolumeBackupProperties

名字 描述 价值
backupEnabled 备份已启用 bool
backupPolicyId 备份策略资源 ID 字符串
policyEnforced 策略强制实施 bool
vaultId 保管库资源 ID 字符串

ReplicationObject

名字 描述 价值
endpointType 指示本地卷是卷复制的源还是目标 “dst”
'src'
remoteVolumeRegion 卷复制另一端的远程区域。 字符串
remoteVolumeResourceId 远程卷的资源 ID。 string (必需)
replicationId Id 字符串
replicationSchedule 附表 “_10minutely”
“daily”
“hourly”(必需)

VolumeSnapshotProperties

名字 描述 价值
snapshotPolicyId 快照策略 ResourceId 字符串

VolumePropertiesExportPolicy

名字 描述 价值
规则 导出策略规则 ExportPolicyRule[]

ExportPolicyRule

名字 描述 价值
allowedClients 客户端入口规范为逗号分隔字符串,带有 IPv4CIDR、IPv4 主机地址和主机名 字符串
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

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用 NFSV3/NFSv4.1 卷创建新的 ANF 资源

部署到 Azure
使用此模板,可以使用单个容量池和配置了 NFSV3 或 NFSv4.1 协议的单个卷创建新的 Azure NetApp 文件资源。 它们都与要创建的任何卷所需的 Azure 虚拟网络和委派子网一起部署
使用 SMB 卷 创建新的 ANF 资源

部署到 Azure
使用此模板,可以使用单个容量池和配置 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@2021-04-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      backupId = "string"
      creationToken = "string"
      dataProtection = {
        backup = {
          backupEnabled = bool
          backupPolicyId = "string"
          policyEnforced = bool
          vaultId = "string"
        }
        replication = {
          endpointType = "string"
          remoteVolumeRegion = "string"
          remoteVolumeResourceId = "string"
          replicationId = "string"
          replicationSchedule = "string"
        }
        snapshot = {
          snapshotPolicyId = "string"
        }
      }
      encryptionKeySource = "string"
      exportPolicy = {
        rules = [
          {
            allowedClients = "string"
            cifs = bool
            hasRootAccess = bool
            kerberos5iReadWrite = bool
            kerberos5pReadWrite = bool
            kerberos5ReadWrite = bool
            nfsv3 = bool
            nfsv41 = bool
            ruleIndex = int
            unixReadWrite = bool
          }
        ]
      }
      isRestoring = bool
      kerberosEnabled = bool
      ldapEnabled = bool
      networkFeatures = "string"
      protocolTypes = [
        "string"
      ]
      securityStyle = "string"
      serviceLevel = "string"
      smbContinuouslyAvailable = bool
      smbEncryption = bool
      snapshotDirectoryVisible = bool
      snapshotId = "string"
      subnetId = "string"
      throughputMibps = int
      usageThreshold = int
      volumeType = "string"
    }
  })
}

属性值

netAppAccounts/capacityPools/volumes

名字 描述 价值
类型 资源类型 “Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-04-01-preview”
名字 资源名称 string (必需)
位置 资源位置 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:capacityPools
标签 资源标记 标记名称和值的字典。
性能 卷属性 VolumeProperties(必需)

VolumeProperties

名字 描述 价值
backupId 用于标识备份的 UUID v4 或资源标识符。 字符串

约束:
最小长度 = 36
最大长度 = 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}|(\\?([^\/]*[\/])*)([^\/]+)$
creationToken 卷的唯一文件路径。 创建装载目标时使用 string (必需)

约束:
最小长度 = 1
最大长度 = 80
Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$
dataProtection DataProtection 类型卷包含包含复制详细信息的对象 VolumePropertiesDataProtection
encryptionKeySource 加密密钥源。 可能的值为:“Microsoft.NetApp” 字符串
exportPolicy 导出策略规则集 VolumePropertiesExportPolicy
isRestoring 恢复 bool
kerberosEnabled 描述卷是否为 KerberosEnabled。 与 swagger 版本 2020-05-01 或更高版本一起使用 bool
ldapEnabled 指定是否为给定 NFS 卷启用 LDAP。 bool
networkFeatures 卷可用的基本网络或标准功能。 “Basic”
“Standard”
protocolTypes 协议类型集、默认 NFSv3、SMB 协议的 CIFS string[]
securityStyle 卷的安全样式(默认 unix)默认为 ntfs(对于双重协议或 CIFS 协议) “ntfs”
“unix”
serviceLevel 文件系统的服务级别 “Premium”
“Standard”
“Ultra”
smbContinuouslyAvailable 为 smb 卷启用连续可用的共享属性。 仅适用于 SMB 卷 bool
smbEncryption 为正在进行的 smb3 数据启用加密。 仅适用于 SMB/DualProtocol 卷。 与 swagger 版本 2020-08-01 或更高版本一起使用 bool
snapshotDirectoryVisible 如果启用(true),卷将包含只读快照目录,该目录提供对每个卷快照的访问权限(默认为 true)。 bool
snapshotId 用于标识快照的 UUID v4 或资源标识符。 字符串

约束:
最小长度 = 36
最大长度 = 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}|(\\?([^\/]*[\/])*)([^\/]+)$
subnetId 委托子网的 Azure 资源 URI。 必须具有委派Microsoft.NetApp/volumes string (必需)
throughputMibps Mibps 中可通过此卷实现的最大吞吐量 int

约束:
最小值 = 0
最大值 = 4500
usageThreshold 文件系统允许的最大存储配额(以字节为单位)。 这是仅用于警报的软配额。 最小大小为 100 GiB。 上限为 100TiB。 以字节为单位指定。 int (必需)

约束:
最小值 = 107374182400
最大值 = 109951162777600
volumeType 卷的类型是什么 字符串

VolumePropertiesDataProtection

名字 描述 价值
备份 备份属性 VolumeBackupProperties
复制 复制属性 ReplicationObject
快照 快照属性。 VolumeSnapshotProperties

VolumeBackupProperties

名字 描述 价值
backupEnabled 备份已启用 bool
backupPolicyId 备份策略资源 ID 字符串
policyEnforced 策略强制实施 bool
vaultId 保管库资源 ID 字符串

ReplicationObject

名字 描述 价值
endpointType 指示本地卷是卷复制的源还是目标 “dst”
“src”
remoteVolumeRegion 卷复制另一端的远程区域。 字符串
remoteVolumeResourceId 远程卷的资源 ID。 string (必需)
replicationId Id 字符串
replicationSchedule 附表 “_10minutely”
“daily”
“每小时”(必需)

VolumeSnapshotProperties

名字 描述 价值
snapshotPolicyId 快照策略 ResourceId 字符串

VolumePropertiesExportPolicy

名字 描述 价值
规则 导出策略规则 ExportPolicyRule[]

ExportPolicyRule

名字 描述 价值
allowedClients 客户端入口规范为逗号分隔字符串,带有 IPv4CIDR、IPv4 主机地址和主机名 字符串
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