Create an Azure file share with Microsoft.FileShares (preview)

To create a file share via the Azure portal, use the search box at the top of the Azure portal to search for file share and select the matching result.

Select + Create to create a new file share.

Basics

The first tab to complete creating a file share is labeled Basics, which contains the required fields to create a file share.

Advanced

The Advanced tab is optional and provides more granular settings. You can choose to set up root squash options or specify a mount name for the file share. Mount name allows you to choose a different name to use to mount the file share. By default, it's the same as the file share name. Customize it if you want a unique mount name. The same rules still apply to the naming policy. See Naming rules and restrictions for Azure resources.

Networking

Using the NFS protocol for a file share requires network-level security configurations. There are two options for establishing networking-level security configurations: Private endpoint and service endpoint.

A private endpoint gives your file share a private, static IP address within your virtual network, preventing connectivity interruptions from dynamic IP address changes. Traffic to your file share stays within peered virtual networks, including those in other regions and on premises. You can set up a private endpoint after you create the file share. For region support on private endpoints for Microsoft.Fileshares, see Plan to deploy Azure Files.

If you don't require a static IP address, you can enable a service endpoint for Azure Files within the virtual network. A service endpoint configures file share to allow access only from specific subnets. The allowed subnets can belong to a virtual network in the same subscription or a different subscription, including those that belong to a different Microsoft Entra tenant. There's no extra charge for using service endpoints. You can create or choose an existing virtual network for service endpoint purpose in the networking tab during the create flow.

Tags

Tags are name/value pairs that enable you to categorize resources and view consolidated billing by applying the same tag to multiple resources and resource groups. These are optional, and you can apply them after you create the file share.

Review + create

The final step to create the file share is to select the Create button on the Review + create tab. This button isn't available until you complete all the required fields.

Set up a private endpoint

1. After the file share is created, search for private endpoint in the search bar, and then click on create button.

2. Leave Subscription and Resource group the same. Under Instance, provide a name and select a region for the new private endpoint. Your private endpoint must be in the same region as your virtual network, so use the same region as you specified when creating the VM. When all the fields are complete, select Next: Resource.

   

3. Confirm that the Subscription, and Resource are correct. Choose Microsoft.FileShares/fileShares as the Resource type, and select FileShare from the Target sub-resource drop-down. Then select Next: Virtual Network.

   

4. Under Networking, select the virtual network associated with your VM and leave the default subnet. Under Private IP configuration, leave Dynamically allocate IP address selected. Select Next: DNS.

5. Select Yes for Integrate with private DNS zone. Make sure the correct subscription and resource group are selected, and then select Next: Tags.

6. You can optionally apply tags to categorize your resources, such as applying the name Environment and the value Test to all testing resources. Enter name/value pairs if desired, and then select Next: Review + create.

7. Azure will attempt to validate the private endpoint. When validation is complete, select Create. You'll see a notification that deployment is in progress. After a few minutes, you should see a notification that deployment is complete.

To create a file share via PowerShell, run this command.

New-AzResource -ResourceType "Microsoft.FileShares/fileShares" `
               -ResourceName "<your-file-share-name>" `
               -Location "<intended-region-for-deployment>" `
               -ResourceGroupName "<your-resource-group-name>" `
               -Properties @{
                   # redundancy support "Local" and "Zone"
                   redundancy = "Local"
                   protocol = "NFS"
                   provisionedStorageGiB = <intended capacity>
                   ProvisionedIoPerSec = <intended IOPS> 
                   ProvisionedThroughputMiBPerSec = <intended throughput>
                   mediaTier = "SSD"
                   # optional: mountName = "<mount-name-for-file-share>"
                   nfsProtocolProperties = @{
                       rootSquash = "RootSquash"
                   }
               } `
               -Force

To create a file share via Azure CLI, run this command.

az resource create \
  --resource-type "Microsoft.FileShares/fileShares" \
  --name <your-file-share-name> \
  --location <intended-region-for-deployment> \
  --resource-group <your-resource-group-name> \
  --properties '{
    # redundancy support "Local" and "Zone"
    "redundancy": "Local",
    "protocol": "NFS",
    "provisionedStorageGiB": <intended capacity>,
    "ProvisionedIoPerSec": <intended IOPS>,
    "ProvisionedThroughputMiBPerSec": <intended throughput,
    "mediaTier": "SSD",
    "nfsProtocolProperties": {
      "rootSquash": "RootSquash"
    }
}'