Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The netAppAccounts/capacityPools/volumes/buckets resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets@2025-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
fileSystemUser: {
cifsUser: {
username: 'string'
}
nfsUser: {
groupId: int
userId: int
}
}
path: 'string'
permissions: 'string'
server: {
certificateObject: 'string'
fqdn: 'string'
}
}
}
Property Values
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^([a-z]|(\d(?!\d{0,2}\.\d{1,3}\.\d{1,3}\.\d{1,3})))([a-z\d]|(\.(?!(\.|-)))|(-(?!\.))){1,61}[a-z\d]$ (required) |
| 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: netAppAccounts/capacityPools/volumes |
| properties | Bucket properties | BucketProperties |
BucketProperties
| Name | Description | Value |
|---|---|---|
| fileSystemUser | File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. | FileSystemUser |
| path | The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. | string |
| permissions | Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. | 'ReadOnly' 'ReadWrite' |
| server | Properties of the server managing the lifecycle of volume buckets | BucketServerProperties |
BucketServerProperties
| Name | Description | Value |
|---|---|---|
| certificateObject | A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. | string Constraints: Min length = 1 Max length = 10240 |
| fqdn | The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. | string |
CifsUser
| Name | Description | Value |
|---|---|---|
| username | The CIFS user's username | string |
FileSystemUser
| Name | Description | Value |
|---|---|---|
| cifsUser | The effective CIFS username when accessing the volume data. | CifsUser |
| nfsUser | The effective NFS User ID and Group ID when accessing the volume data. | NfsUser |
NfsUser
| Name | Description | Value |
|---|---|---|
| groupId | The NFS user's GID | int |
| userId | The NFS user's UID | int |
ARM template resource definition
The netAppAccounts/capacityPools/volumes/buckets resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets resource, add the following JSON to your template.
{
"type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets",
"apiVersion": "2025-09-01-preview",
"name": "string",
"properties": {
"fileSystemUser": {
"cifsUser": {
"username": "string"
},
"nfsUser": {
"groupId": "int",
"userId": "int"
}
},
"path": "string",
"permissions": "string",
"server": {
"certificateObject": "string",
"fqdn": "string"
}
}
}
Property Values
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-09-01-preview' |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^([a-z]|(\d(?!\d{0,2}\.\d{1,3}\.\d{1,3}\.\d{1,3})))([a-z\d]|(\.(?!(\.|-)))|(-(?!\.))){1,61}[a-z\d]$ (required) |
| properties | Bucket properties | BucketProperties |
| type | The resource type | 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets' |
BucketProperties
| Name | Description | Value |
|---|---|---|
| fileSystemUser | File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. | FileSystemUser |
| path | The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. | string |
| permissions | Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. | 'ReadOnly' 'ReadWrite' |
| server | Properties of the server managing the lifecycle of volume buckets | BucketServerProperties |
BucketServerProperties
| Name | Description | Value |
|---|---|---|
| certificateObject | A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. | string Constraints: Min length = 1 Max length = 10240 |
| fqdn | The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. | string |
CifsUser
| Name | Description | Value |
|---|---|---|
| username | The CIFS user's username | string |
FileSystemUser
| Name | Description | Value |
|---|---|---|
| cifsUser | The effective CIFS username when accessing the volume data. | CifsUser |
| nfsUser | The effective NFS User ID and Group ID when accessing the volume data. | NfsUser |
NfsUser
| Name | Description | Value |
|---|---|---|
| groupId | The NFS user's GID | int |
| userId | The NFS user's UID | int |
Usage Examples
Terraform (AzAPI provider) resource definition
The netAppAccounts/capacityPools/volumes/buckets resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets@2025-09-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
fileSystemUser = {
cifsUser = {
username = "string"
}
nfsUser = {
groupId = int
userId = int
}
}
path = "string"
permissions = "string"
server = {
certificateObject = "string"
fqdn = "string"
}
}
}
}
Property Values
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^([a-z]|(\d(?!\d{0,2}\.\d{1,3}\.\d{1,3}\.\d{1,3})))([a-z\d]|(\.(?!(\.|-)))|(-(?!\.))){1,61}[a-z\d]$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: netAppAccounts/capacityPools/volumes |
| properties | Bucket properties | BucketProperties |
| type | The resource type | "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/buckets@2025-09-01-preview" |
BucketProperties
| Name | Description | Value |
|---|---|---|
| fileSystemUser | File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. | FileSystemUser |
| path | The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. | string |
| permissions | Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. | 'ReadOnly' 'ReadWrite' |
| server | Properties of the server managing the lifecycle of volume buckets | BucketServerProperties |
BucketServerProperties
| Name | Description | Value |
|---|---|---|
| certificateObject | A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. | string Constraints: Min length = 1 Max length = 10240 |
| fqdn | The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. | string |
CifsUser
| Name | Description | Value |
|---|---|---|
| username | The CIFS user's username | string |
FileSystemUser
| Name | Description | Value |
|---|---|---|
| cifsUser | The effective CIFS username when accessing the volume data. | CifsUser |
| nfsUser | The effective NFS User ID and Group ID when accessing the volume data. | NfsUser |
NfsUser
| Name | Description | Value |
|---|---|---|
| groupId | The NFS user's GID | int |
| userId | The NFS user's UID | int |