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 fileShares 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.FileShares/fileShares resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.FileShares/fileShares@2025-06-01-preview' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
mediaTier: 'string'
mountName: 'string'
nfsProtocolProperties: {
rootSquash: 'string'
}
protocol: 'string'
provisionedIOPerSec: int
provisionedStorageGiB: int
provisionedThroughputMiBPerSec: int
publicAccessProperties: {
allowedSubnets: [
'string'
]
}
publicNetworkAccess: 'string'
redundancy: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.FileShares/fileShares
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-z]|[0-9])([a-z]|[0-9]|(-(?!-))){1,61}([a-z]|[0-9])$ (required) |
| properties | The resource-specific properties for this resource. | FileShareProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
FileShareProperties
| Name | Description | Value |
|---|---|---|
| mediaTier | The storage media tier of the file share. | 'SSD' |
| mountName | The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. | string |
| nfsProtocolProperties | Protocol settings specific NFS. | NfsProtocolProperties |
| protocol | The file sharing protocol for this file share. | 'NFS' |
| provisionedIOPerSec | The provisioned IO / sec of the share. | int |
| provisionedStorageGiB | The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. | int |
| provisionedThroughputMiBPerSec | The provisioned throughput / sec of the share. | int |
| publicAccessProperties | The set of properties for control public access. | PublicAccessProperties |
| publicNetworkAccess | Gets or sets allow or disallow public network access to azure managed file share | 'Disabled' 'Enabled' |
| redundancy | The chosen redundancy level of the file share. | 'Local' 'Zone' |
NfsProtocolProperties
| Name | Description | Value |
|---|---|---|
| rootSquash | Root squash defines how root users on clients are mapped to the NFS share. | 'AllSquash' 'NoRootSquash' 'RootSquash' |
PublicAccessProperties
| Name | Description | Value |
|---|---|---|
| allowedSubnets | The allowed set of subnets when access is restricted. | string[] |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The fileShares 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.FileShares/fileShares resource, add the following JSON to your template.
{
"type": "Microsoft.FileShares/fileShares",
"apiVersion": "2025-06-01-preview",
"name": "string",
"location": "string",
"properties": {
"mediaTier": "string",
"mountName": "string",
"nfsProtocolProperties": {
"rootSquash": "string"
},
"protocol": "string",
"provisionedIOPerSec": "int",
"provisionedStorageGiB": "int",
"provisionedThroughputMiBPerSec": "int",
"publicAccessProperties": {
"allowedSubnets": [ "string" ]
},
"publicNetworkAccess": "string",
"redundancy": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.FileShares/fileShares
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-06-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-z]|[0-9])([a-z]|[0-9]|(-(?!-))){1,61}([a-z]|[0-9])$ (required) |
| properties | The resource-specific properties for this resource. | FileShareProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.FileShares/fileShares' |
FileShareProperties
| Name | Description | Value |
|---|---|---|
| mediaTier | The storage media tier of the file share. | 'SSD' |
| mountName | The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. | string |
| nfsProtocolProperties | Protocol settings specific NFS. | NfsProtocolProperties |
| protocol | The file sharing protocol for this file share. | 'NFS' |
| provisionedIOPerSec | The provisioned IO / sec of the share. | int |
| provisionedStorageGiB | The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. | int |
| provisionedThroughputMiBPerSec | The provisioned throughput / sec of the share. | int |
| publicAccessProperties | The set of properties for control public access. | PublicAccessProperties |
| publicNetworkAccess | Gets or sets allow or disallow public network access to azure managed file share | 'Disabled' 'Enabled' |
| redundancy | The chosen redundancy level of the file share. | 'Local' 'Zone' |
NfsProtocolProperties
| Name | Description | Value |
|---|---|---|
| rootSquash | Root squash defines how root users on clients are mapped to the NFS share. | 'AllSquash' 'NoRootSquash' 'RootSquash' |
PublicAccessProperties
| Name | Description | Value |
|---|---|---|
| allowedSubnets | The allowed set of subnets when access is restricted. | string[] |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The fileShares 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.FileShares/fileShares resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.FileShares/fileShares@2025-06-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
mediaTier = "string"
mountName = "string"
nfsProtocolProperties = {
rootSquash = "string"
}
protocol = "string"
provisionedIOPerSec = int
provisionedStorageGiB = int
provisionedThroughputMiBPerSec = int
publicAccessProperties = {
allowedSubnets = [
"string"
]
}
publicNetworkAccess = "string"
redundancy = "string"
}
}
}
Property Values
Microsoft.FileShares/fileShares
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-z]|[0-9])([a-z]|[0-9]|(-(?!-))){1,61}([a-z]|[0-9])$ (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | The resource-specific properties for this resource. | FileShareProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.FileShares/fileShares@2025-06-01-preview" |
FileShareProperties
| Name | Description | Value |
|---|---|---|
| mediaTier | The storage media tier of the file share. | 'SSD' |
| mountName | The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. | string |
| nfsProtocolProperties | Protocol settings specific NFS. | NfsProtocolProperties |
| protocol | The file sharing protocol for this file share. | 'NFS' |
| provisionedIOPerSec | The provisioned IO / sec of the share. | int |
| provisionedStorageGiB | The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. | int |
| provisionedThroughputMiBPerSec | The provisioned throughput / sec of the share. | int |
| publicAccessProperties | The set of properties for control public access. | PublicAccessProperties |
| publicNetworkAccess | Gets or sets allow or disallow public network access to azure managed file share | 'Disabled' 'Enabled' |
| redundancy | The chosen redundancy level of the file share. | 'Local' 'Zone' |
NfsProtocolProperties
| Name | Description | Value |
|---|---|---|
| rootSquash | Root squash defines how root users on clients are mapped to the NFS share. | 'AllSquash' 'NoRootSquash' 'RootSquash' |
PublicAccessProperties
| Name | Description | Value |
|---|---|---|
| allowedSubnets | The allowed set of subnets when access is restricted. | string[] |
TrackedResourceTags
| Name | Description | Value |
|---|