Microsoft.NetApp netAppAccounts/capacityPools/volumes 2019-05-01
- Latest
- 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 resource definition
The netAppAccounts/capacityPools/volumes resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-05-01' = {
name: 'string'
location: 'string'
tags: any()
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
creationToken: 'string'
exportPolicy: {
rules: [
{
allowedClients: 'string'
cifs: bool
nfsv3: bool
nfsv4: bool
ruleIndex: int
unixReadWrite: bool
}
]
}
mountTargets: [
{
endIp: 'string'
fileSystemId: 'string'
gateway: 'string'
netmask: 'string'
smbServerFqdn: 'string'
startIp: 'string'
subnet: 'string'
}
]
protocolTypes: [
'string'
]
serviceLevel: 'string'
snapshotId: 'string'
subnetId: 'string'
usageThreshold: int
}
}
Property values
netAppAccounts/capacityPools/volumes
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| location | Resource location | string (required) |
| tags | Resource tags | For Bicep, you can use the any() function. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: capacityPools |
| properties | Volume properties | VolumeProperties (required) |
VolumeProperties
| Name | Description | Value |
|---|---|---|
| creationToken | A unique file path for the volume. Used when creating mount targets | string (required) |
| exportPolicy | Set of export policy rules | VolumePropertiesExportPolicy |
| mountTargets | List of mount targets | MountTargetProperties[] |
| protocolTypes | Set of protocol types | string[] |
| serviceLevel | The service level of the file system | 'Premium' 'Standard' 'Ultra' |
| snapshotId | UUID v4 used to identify the Snapshot | string Constraints: Min length = 36 Max length = 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 | The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes | string (required) |
| usageThreshold | Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes. | int (required) Constraints: Min value = 107374182400 Max value = 109951162777600 |
VolumePropertiesExportPolicy
| Name | Description | Value |
|---|---|---|
| rules | Export policy rule | ExportPolicyRule[] |
ExportPolicyRule
| Name | Description | Value |
|---|---|---|
| allowedClients | Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names | string |
| cifs | Allows CIFS protocol | bool |
| nfsv3 | Allows NFSv3 protocol | bool |
| nfsv4 | Deprecated: Will use the NFSv4.1 protocol, please use swagger version 2019-07-01 or later | bool |
| ruleIndex | Order index | int |
| unixReadWrite | Read and write access | bool |
MountTargetProperties
| Name | Description | Value |
|---|---|---|
| endIp | The end of IPv4 address range to use when creating a new mount target | string |
| fileSystemId | UUID v4 used to identify the MountTarget | string (required) Constraints: Min length = 36 Max length = 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}$ |
| gateway | The gateway of the IPv4 address range to use when creating a new mount target | string |
| netmask | The netmask of the IPv4 address range to use when creating a new mount target | string |
| smbServerFqdn | The SMB server's Fully Qualified Domain Name, FQDN | string |
| startIp | The start of IPv4 address range to use when creating a new mount target | string |
| subnet | The subnet | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create new ANF resource with NFSV3/NFSv4.1 volume |
This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with NFSV3 or NFSv4.1 protocol. They are all deployed together with Azure Virtual Network and Delegated subnet that are required for any volume to be created |
| Create new ANF resource with SMB volume |
This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with SMB protocol. |
ARM template resource definition
The netAppAccounts/capacityPools/volumes resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes resource, add the following JSON to your template.
{
"type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
"apiVersion": "2019-05-01",
"name": "string",
"location": "string",
"tags": {},
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"creationToken": "string",
"exportPolicy": {
"rules": [
{
"allowedClients": "string",
"cifs": "bool",
"nfsv3": "bool",
"nfsv4": "bool",
"ruleIndex": "int",
"unixReadWrite": "bool"
}
]
},
"mountTargets": [
{
"endIp": "string",
"fileSystemId": "string",
"gateway": "string",
"netmask": "string",
"smbServerFqdn": "string",
"startIp": "string",
"subnet": "string"
}
],
"protocolTypes": [ "string" ],
"serviceLevel": "string",
"snapshotId": "string",
"subnetId": "string",
"usageThreshold": "int"
}
}
Property values
netAppAccounts/capacityPools/volumes
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes' |
| apiVersion | The resource api version | '2019-05-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| location | Resource location | string (required) |
| tags | Resource tags | |
| properties | Volume properties | VolumeProperties (required) |
VolumeProperties
| Name | Description | Value |
|---|---|---|
| creationToken | A unique file path for the volume. Used when creating mount targets | string (required) |
| exportPolicy | Set of export policy rules | VolumePropertiesExportPolicy |
| mountTargets | List of mount targets | MountTargetProperties[] |
| protocolTypes | Set of protocol types | string[] |
| serviceLevel | The service level of the file system | 'Premium' 'Standard' 'Ultra' |
| snapshotId | UUID v4 used to identify the Snapshot | string Constraints: Min length = 36 Max length = 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 | The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes | string (required) |
| usageThreshold | Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes. | int (required) Constraints: Min value = 107374182400 Max value = 109951162777600 |
VolumePropertiesExportPolicy
| Name | Description | Value |
|---|---|---|
| rules | Export policy rule | ExportPolicyRule[] |
ExportPolicyRule
| Name | Description | Value |
|---|---|---|
| allowedClients | Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names | string |
| cifs | Allows CIFS protocol | bool |
| nfsv3 | Allows NFSv3 protocol | bool |
| nfsv4 | Deprecated: Will use the NFSv4.1 protocol, please use swagger version 2019-07-01 or later | bool |
| ruleIndex | Order index | int |
| unixReadWrite | Read and write access | bool |
MountTargetProperties
| Name | Description | Value |
|---|---|---|
| endIp | The end of IPv4 address range to use when creating a new mount target | string |
| fileSystemId | UUID v4 used to identify the MountTarget | string (required) Constraints: Min length = 36 Max length = 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}$ |
| gateway | The gateway of the IPv4 address range to use when creating a new mount target | string |
| netmask | The netmask of the IPv4 address range to use when creating a new mount target | string |
| smbServerFqdn | The SMB server's Fully Qualified Domain Name, FQDN | string |
| startIp | The start of IPv4 address range to use when creating a new mount target | string |
| subnet | The subnet | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create new ANF resource with NFSV3/NFSv4.1 volume |
This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with NFSV3 or NFSv4.1 protocol. They are all deployed together with Azure Virtual Network and Delegated subnet that are required for any volume to be created |
| Create new ANF resource with SMB volume |
This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with SMB protocol. |
Terraform (AzAPI provider) resource definition
The netAppAccounts/capacityPools/volumes resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-05-01"
name = "string"
location = "string"
parent_id = "string"
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
creationToken = "string"
exportPolicy = {
rules = [
{
allowedClients = "string"
cifs = bool
nfsv3 = bool
nfsv4 = bool
ruleIndex = int
unixReadWrite = bool
}
]
}
mountTargets = [
{
endIp = "string"
fileSystemId = "string"
gateway = "string"
netmask = "string"
smbServerFqdn = "string"
startIp = "string"
subnet = "string"
}
]
protocolTypes = [
"string"
]
serviceLevel = "string"
snapshotId = "string"
subnetId = "string"
usageThreshold = int
}
})
}
Property values
netAppAccounts/capacityPools/volumes
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-05-01" |
| name | The resource name | string (required) |
| location | Resource location | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: capacityPools |
| tags | Resource tags | |
| properties | Volume properties | VolumeProperties (required) |
VolumeProperties
| Name | Description | Value |
|---|---|---|
| creationToken | A unique file path for the volume. Used when creating mount targets | string (required) |
| exportPolicy | Set of export policy rules | VolumePropertiesExportPolicy |
| mountTargets | List of mount targets | MountTargetProperties[] |
| protocolTypes | Set of protocol types | string[] |
| serviceLevel | The service level of the file system | "Premium" "Standard" "Ultra" |
| snapshotId | UUID v4 used to identify the Snapshot | string Constraints: Min length = 36 Max length = 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 | The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes | string (required) |
| usageThreshold | Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes. | int (required) Constraints: Min value = 107374182400 Max value = 109951162777600 |
VolumePropertiesExportPolicy
| Name | Description | Value |
|---|---|---|
| rules | Export policy rule | ExportPolicyRule[] |
ExportPolicyRule
| Name | Description | Value |
|---|---|---|
| allowedClients | Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names | string |
| cifs | Allows CIFS protocol | bool |
| nfsv3 | Allows NFSv3 protocol | bool |
| nfsv4 | Deprecated: Will use the NFSv4.1 protocol, please use swagger version 2019-07-01 or later | bool |
| ruleIndex | Order index | int |
| unixReadWrite | Read and write access | bool |
MountTargetProperties
| Name | Description | Value |
|---|---|---|
| endIp | The end of IPv4 address range to use when creating a new mount target | string |
| fileSystemId | UUID v4 used to identify the MountTarget | string (required) Constraints: Min length = 36 Max length = 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}$ |
| gateway | The gateway of the IPv4 address range to use when creating a new mount target | string |
| netmask | The netmask of the IPv4 address range to use when creating a new mount target | string |
| smbServerFqdn | The SMB server's Fully Qualified Domain Name, FQDN | string |
| startIp | The start of IPv4 address range to use when creating a new mount target | string |
| subnet | The subnet | string |