Share via


Microsoft.NetApp netAppAccounts/capacityPools/volumes

Bicep 資源定義

netAppAccounts/capacityPools/volumes 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-07-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

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
需要字串 ()
location 資源所在的地理位置 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: capacityPools
properties 磁碟區屬性 需要 VolumeProperties ()
zones (區域) 可用性區域 string[]

約束:
最小長度 = 1
最大長度 = 255

VolumeProperties

名稱 描述
avsDataStore 指定磁碟區是否啟用 Azure VMware 解決方案 (AVS) 資料存放區用途 'Disabled'
'Enabled'
backupId 用來識別備份的 UUID v4 或資源識別碼。 字串
capacityPoolResourceId 透過磁碟區群組建立磁碟區時使用的集區資源標識符 字串
coolAccess 指定是否為磁碟區啟用非經常性存取 (階層處理) 。 bool
coolAccessRetrievalPolicy coolAccessRetrievalPolicy 會根據非經常性存取啟用磁碟區的讀取模式,判斷從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為:
預設值 - 資料會從非經常性存取層提取到隨機讀取的標準記憶體。 此原則是預設值。
OnRead - 所有用戶端驅動數據讀取都會從非經常性存取層提取到循序和隨機讀取的標準記憶體。
永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。
'Default'
'Never'
'OnRead'
coolnessPeriod 指定客戶端未存取之數據的分層天數。 int

約束:
最小值 = 7
最大值 = 183
creationToken 磁碟區的唯一檔案路徑。 建立掛接目標時使用 需要字串 ()

約束:
最小長度 = 1
最大長度 = 80
模式 = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$
dataProtection DataProtection 類型磁碟區包含包含複寫詳細數據的物件 VolumePropertiesDataProtection
defaultGroupQuotaInKiBs KiB 中磁碟區的預設群組配額。 如果已設定 isDefaultQuotaEnabled,則會套用 4 KiB 的最小值。 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 私人端點的資源標識碼。 它必須與磁碟區位於相同的 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 字串 (必要)
throughputMibps MiB/s 中可達成此磁碟區的最大輸送量,而且這隻會接受為手動 qosType 磁碟區的輸入 int
unixPermissions 以八進位 4 位數格式接受的 NFS 磁碟區 UNIX 許可權。 第一個數位會選取設定使用者標識碼 (4) 、將群組標識符設定 (為 2) ,並 (1 個) 属性。 第二位數會選取檔案擁有者的許可權:讀取 (4) 、寫入 (2) ,然後執行 (1) 。 第三個會選取相同群組中其他用戶的許可權。 非群組中其他使用者的第四個。 0755 - 授與讀取/寫入/執行許可權給擁有者和讀取/執行給群組和其他使用者。 字串

約束:
最小長度 = 4
最大長度 = 4
usageThreshold 以位元組為單位的檔案系統允許的記憶體配額上限。 這是僅用於警示的軟配額。 大小下限為 100 GiB。 上限為 100TiB、500Tib for LargeVolume 或 2400Tib for LargeVolume。例外狀況。 以位元組為單位指定。 int (必要)

約束:
最小值 = 107374182400
最大值 = 2638827906662400
volumeSpecName 磁碟區規格名稱是磁碟區群組中特定磁碟區的應用程式特定指定或標識元,例如數據、記錄檔 字串
volumeType 磁碟區的類型是這樣。 針對跨區域復寫中的目的地磁碟區,請將類型設定為 DataProtection 字串

VolumePropertiesDataProtection

名稱 描述
複寫 複寫屬性 ReplicationObject
快照集 快照集屬性。 VolumeSnapshotProperties
volumeRelocation VolumeRelocation 屬性 VolumeRelocationProperties

ReplicationObject

名稱 描述
endpointType 指出本機磁碟區是否為磁碟區復寫的來源或目的地 'dst'
'src'
remoteVolumeRegion 磁碟區復寫另一端的遠端區域。 字串
remoteVolumeResourceId 遠端磁碟區的資源標識碼。 字串 (必要)
replicationSchedule 排程 '_10minutely'
'daily'
'hourly'

VolumeSnapshotProperties

名稱 描述
snapshotPolicyId 快照集原則 ResourceId 字串

VolumeRelocationProperties

名稱 描述
relocationRequested 已要求重新配置此磁碟區 bool

VolumePropertiesExportPolicy

名稱 描述
規則 匯出原則規則 ExportPolicyRule[]

ExportPolicyRule

名稱 描述
allowedClients 以逗號分隔字串的用戶端輸入規格,其中包含IPv4CIDR、IPv4 主機名和主機名 字串
chownMode 此參數指定有權變更檔案擁有權的人員。 受限制 - 只有根使用者可以變更檔案的擁有權。 不受限制 - 非根使用者可以變更其擁有的檔案擁有權。 'Restricted'
'Unrestricted'
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

名稱 描述
索引鍵 磁碟區群組中放置磁碟區的應用程式特定參數索引鍵 字串 (必要)
磁碟區群組中磁碟區放置的應用程式特定參數值 字串 (必要)

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用 NFSV3/NFSv4.1 磁碟區建立新的 ANF 資源

部署至 Azure
此範本可讓您建立新的 Azure NetApp Files 資源,其中包含使用NFSV3或 NFSv4.1 通訊協定設定的單一容量集區和單一磁碟區。 它們全都部署在一起,以及建立任何磁碟區所需的 Azure 虛擬網路 和委派子網
使用 SMB 磁碟區建立新的 ANF 資源

部署至 Azure
此範本可讓您使用單一容量集區和使用SMB通訊協定設定的單一磁碟區來建立新的 Azure NetApp Files 資源。

ARM 範本資源定義

netAppAccounts/capacityPools/volumes 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "apiVersion": "2023-07-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-07-01'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。
字串 (必要)
location 資源所在的地理位置 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
properties 磁碟區屬性 需要 VolumeProperties ()
zones (區域) 可用性區域 string[]

約束:
最小長度 = 1
最大長度 = 255

VolumeProperties

名稱 描述
avsDataStore 指定磁碟區是否啟用 Azure VMware 解決方案 (AVS) 資料存放區用途 'Disabled'
'Enabled'
backupId 用來識別備份的 UUID v4 或資源識別碼。 字串
capacityPoolResourceId 集區資源標識碼,用於透過磁碟區群組建立磁碟區 字串
coolAccess 指定磁碟區是否啟用非經常性存取 (階層處理) 。 bool
coolAccessRetrievalPolicy coolAccessRetrievalPolicy 會根據啟用非經常性存取之磁碟區的讀取模式,判斷從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為:
預設值 - 資料會從非經常性存取層提取到隨機讀取的標準記憶體。 此原則是預設值。
OnRead - 所有用戶端驅動數據讀取都會從非經常性層提取到循序和隨機讀取的標準記憶體。
永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。
'Default'
'Never'
'OnRead'
coolnessPeriod 指定用戶端不會存取的數據分層的天數。 int

約束:
最小值 = 7
最大值 = 183
creationToken 磁碟區的唯一檔案路徑。 建立掛接目標時使用 字串 (必要)

約束:
最小長度 = 1
最大長度 = 80
模式 = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$
dataProtection DataProtection 類型磁碟區包含包含複寫詳細數據的物件 VolumePropertiesDataProtection
defaultGroupQuotaInKiBs KiB 中磁碟區的預設群組配額。 如果已設定 isDefaultQuotaEnabled,則會套用最小值 4 KIB。 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 私人端點的資源標識碼。 它必須位於與磁碟區相同的 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 需要字串 ()
throughputMibps 此磁碟區可達到的MiB/秒輸送量上限,而且這隻會接受為手動qosType磁碟區的輸入 int
unixPermissions 以八進位 4 位數格式接受的 NFS 磁碟區 UNIX 許可權。 第一個數位會選取設定的使用者標識碼 (4) 、將群組標識符設定 (為 2) ,並 (1 個) 屬性。 第二位數會選取檔案擁有者的許可權:讀取 (4) 、寫入 (2) 並執行 (1) 。 第三個會選取相同群組中其他用戶的許可權。 非群組中其他使用者的第四個。 0755 - 授與讀取/寫入/執行許可權給擁有者和讀取/執行給群組和其他使用者。 字串

約束:
最小長度 = 4
最大長度 = 4
usageThreshold 文件系統允許的最大記憶體配額,以位元組為單位。 這是僅用於警示的軟配額。 最小大小為 100 GiB。 上限為 100TiB、500Tib 代表 LargeVolume 或 2400Tib for LargeVolume,以例外為基礎。 以位元組為單位指定。 需要 int ()

約束:
最小值 = 107374182400
最大值 = 2638827906662400
volumeSpecName 磁碟區規格名稱是磁碟區群組中特定磁碟區的應用程式特定指定或標識元,例如數據、記錄 字串
volumeType 這是哪種類型的磁碟區。 針對跨區域復寫中的目的地磁碟區,將類型設定為 DataProtection 字串

VolumePropertiesDataProtection

名稱 描述
複寫 複寫屬性 ReplicationObject
快照集 快照集屬性。 VolumeSnapshotProperties
volumeRelocation VolumeRelocation 屬性 VolumeRelocationProperties

ReplicationObject

名稱 描述
endpointType 指出本機磁碟區是磁碟區復寫的來源或目的地 'dst'
'src'
remoteVolumeRegion 磁碟區復寫另一端的遠端區域。 字串
remoteVolumeResourceId 遠端磁碟區的資源標識碼。 字串 (必要)
replicationSchedule 排程 '_10minutely'
'daily'
'hourly'

VolumeSnapshotProperties

名稱 描述
snapshotPolicyId 快照集原則 ResourceId 字串

VolumeRelocationProperties

名稱 描述
relocationRequested 已要求重新配置此磁碟區 bool

VolumePropertiesExportPolicy

名稱 描述
規則 匯出原則規則 ExportPolicyRule[]

ExportPolicyRule

名稱 描述
allowedClients 以逗號分隔字串的用戶端輸入規格,其中包含IPv4CIDR、IPv4 主機名和主機名 字串
chownMode 此參數指定有權變更檔案擁有權的人員。 受限制 - 只有根使用者可以變更檔案的擁有權。 不受限制 - 非根使用者可以變更其擁有的檔案擁有權。 'Restricted'
'Unrestricted'
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

名稱 描述
索引鍵 磁碟區群組中放置磁碟區的應用程式特定參數索引鍵 字串 (必要)
磁碟區群組中磁碟區放置的應用程式特定參數值 字串 (必要)

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用 NFSV3/NFSv4.1 磁碟區建立新的 ANF 資源

部署至 Azure
此範本可讓您建立新的 Azure NetApp Files 資源,其中包含單一容量集區,以及使用NFSV3或 NFSv4.1 通訊協定設定的單一磁碟區。 它們全都部署在一起,以及建立任何磁碟區所需的 Azure 虛擬網路 和委派子網
使用 SMB 磁碟區建立新的 ANF 資源

部署至 Azure
此範本可讓您使用單一容量集區和使用SMB通訊協定設定的單一磁碟區來建立新的 Azure NetApp Files 資源。

Terraform (AzAPI 提供者) 資源定義

netAppAccounts/capacityPools/volumes 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.NetApp/netAppAccounts/capacityPools/volumes 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-07-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-07-01”
NAME 資源名稱 需要字串 ()
location 資源所在的地理位置 需要字串 ()
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼: capacityPools
tags 資源標籤。 標記名稱和值的字典。
properties 磁碟區屬性 需要 VolumeProperties ()
zones (區域) 可用性區域 string[]

約束:
最小長度 = 1
最大長度 = 255

VolumeProperties

名稱 描述
avsDataStore 指定磁碟區是否啟用 Azure VMware 解決方案 (AVS) 資料存放區用途 “Disabled”
“Enabled”
backupId 用來識別備份的 UUID v4 或資源識別碼。 字串
capacityPoolResourceId 透過磁碟區群組建立磁碟區時使用的集區資源標識符 字串
coolAccess 指定是否為磁碟區啟用非經常性存取 (階層處理) 。 bool
coolAccessRetrievalPolicy coolAccessRetrievalPolicy 會根據非經常性存取啟用磁碟區的讀取模式,判斷從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為:
預設值 - 資料會從非經常性存取層提取到隨機讀取的標準記憶體。 此原則是預設值。
OnRead - 所有用戶端驅動數據讀取都會從非經常性存取層提取到循序和隨機讀取的標準記憶體。
永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。
“預設值”
“永不”
“OnRead”
coolnessPeriod 指定客戶端未存取之數據的分層天數。 int

約束:
最小值 = 7
最大值 = 183
creationToken 磁碟區的唯一檔案路徑。 建立掛接目標時使用 需要字串 ()

約束:
最小長度 = 1
最大長度 = 80
模式 = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$
dataProtection DataProtection 類型磁碟區包含包含複寫詳細數據的物件 VolumePropertiesDataProtection
defaultGroupQuotaInKiBs KiB 中磁碟區的預設群組配額。 如果已設定 isDefaultQuotaEnabled,則會套用 4 KiB 的最小值。 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 私人端點的資源標識碼。 它必須位於與磁碟區相同的 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 字串 (必要)
throughputMibps MiB/s 中可達成此磁碟區的最大輸送量,而且這隻會接受為手動 qosType 磁碟區的輸入 int
unixPermissions 以八進位 4 位數格式接受的 NFS 磁碟區 UNIX 許可權。 第一個數位會選取設定使用者標識碼 (4) 、將群組標識符設定 (為 2) ,並 (1 個) 属性。 第二位數會選取檔案擁有者的許可權:讀取 (4) 、寫入 (2) ,然後執行 (1) 。 第三個會選取相同群組中其他用戶的許可權。 非群組中其他使用者的第四個。 0755 - 授與讀取/寫入/執行許可權給擁有者和讀取/執行給群組和其他使用者。 字串

約束:
最小長度 = 4
最大長度 = 4
usageThreshold 以位元組為單位的檔案系統允許的記憶體配額上限。 這是僅用於警示的軟配額。 大小下限為 100 GiB。 上限為 100TiB、500Tib for LargeVolume 或 2400Tib for LargeVolume。例外狀況。 以位元組為單位指定。 int (必要)

約束:
最小值 = 107374182400
最大值 = 2638827906662400
volumeSpecName 磁碟區規格名稱是磁碟區群組中特定磁碟區的應用程式特定指定或標識元,例如數據、記錄檔 字串
volumeType 磁碟區的類型是這樣。 針對跨區域復寫中的目的地磁碟區,請將類型設定為 DataProtection 字串

VolumePropertiesDataProtection

名稱 描述
複寫 複寫屬性 ReplicationObject
快照集 快照集屬性。 VolumeSnapshotProperties
volumeRelocation VolumeRelocation 屬性 VolumeRelocationProperties

ReplicationObject

名稱 描述
endpointType 指出本機磁碟區是否為磁碟區復寫的來源或目的地 “dst”
“src”
remoteVolumeRegion 磁碟區復寫另一端的遠端區域。 字串
remoteVolumeResourceId 遠端磁碟區的資源標識碼。 字串 (必要)
replicationSchedule 排程 “_10minutely”
“daily”
“hourly”

VolumeSnapshotProperties

名稱 描述
snapshotPolicyId 快照集原則 ResourceId 字串

VolumeRelocationProperties

名稱 描述
relocationRequested 已要求重新配置此磁碟區 bool

VolumePropertiesExportPolicy

名稱 描述
規則 匯出原則規則 ExportPolicyRule[]

ExportPolicyRule

名稱 描述
allowedClients 以逗號分隔字串的用戶端輸入規格,其中包含IPv4CIDR、IPv4 主機名和主機名 字串
chownMode 此參數指定有權變更檔案擁有權的人員。 受限制 - 只有根使用者可以變更檔案的擁有權。 不受限制 - 非根使用者可以變更其擁有的檔案擁有權。 “受限制”
“Unrestricted”
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

名稱 描述
索引鍵 磁碟區群組中放置磁碟區的應用程式特定參數索引鍵 需要字串 ()
磁碟區群組中磁碟區放置的應用程式特定參數值 需要字串 ()