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.
The Azure MCP Server lets you manage Azure file shares (Microsoft.FileShares) using natural language prompts. You don't need to remember specific command syntax.
✔️ Applies to: File shares created with the Microsoft.FileShares resource provider (preview)
✖️ Doesn't apply to: Classic file shares created with the Microsoft.Storage resource provider
Azure Files is a managed file sharing service in the cloud. Azure file shares provide high-performance, fully managed storage for your applications and workloads. This article applies only to file shares created with the Microsoft.FileShares resource provider (preview), which is currently only available for NFS file shares. It doesn't apply to classic file shares created with the Microsoft.Storage resource provider.
Note
Tool parameters: The Azure MCP Server tools define parameters for data they need to complete tasks. Some of these parameters are specific to each tool and are documented below. Other parameters are global and shared by all tools. For more information, see Tool parameters.
Get limits
Get file share limits for a subscription and location.
Example prompts include:
- "Show me the current file share limits in the 'eastus' location"
- "What are the file share limits for location 'westeurope'?"
- "Get the file share limits for location 'centralus'"
- "Provide the file share limits for location 'eastus2'"
- "Retrieve file share limits for the 'westus' region"
| Parameter | Required or optional | Description |
|---|---|---|
| Location | Required | The Azure region/location name (for example, eastus, westeurope). |
Destructive: ❌ | Idempotent: ✅ | Open World: ❌ | Read Only: ✅ | Secret: ❌ | Local Required: ❌
Get usage
Get file share usage data for a subscription and location.
Example prompts include:
- "Show me the usage details for file shares in location 'eastus'"
- "I want to see usage for file shares in region 'westeurope'"
- "Get usage statistics for file shares in location 'centralus'"
- "Can you provide usage information for file shares in 'eastus2'?"
- "Display usage for file shares in the 'westus' region"
| Parameter | Required or optional | Description |
|---|---|---|
| Location | Required | The Azure region/location name (for example, eastus, westeurope). |
Destructive: ❌ | Idempotent: ✅ | Open World: ❌ | Read Only: ✅ | Secret: ❌ | Local Required: ❌
Get recommendations
Get provisioning parameter recommendations for a file share based on desired storage size.
Example prompts include:
- "Get recommendations for a 1000 GiB file share in location 'eastus'"
- "Can you provide recommendations for a 500 GiB file share in 'westeurope'?"
- "Get details for a 2000 GiB file share in location 'centralus'"
- "I want to see recommendations for a 5000 GiB file share in 'eastus2'"
- "Retrieve recommendations for a 250 GiB file share in the 'westus' region"
| Parameter | Required or optional | Description |
|---|---|---|
| Location | Required | The Azure region/location name (for example, eastus, westeurope). |
| Provisioned storage in GiB (gibibytes) | Required | The desired provisioned storage size of the share in GiB. |
Destructive: ❌ | Idempotent: ✅ | Open World: ❌ | Read Only: ✅ | Secret: ❌ | Local Required: ❌
File Share: Check name availability
Check if a file share name is available in a specific location.
Example prompts include:
- "Can you check if the file share name 'projectdata' is available in location 'eastus'?"
- "I want to see if 'salesbackup' is an available file share name in 'westeurope'"
- "Check the availability of the file share name 'teamfiles' in location 'EastUS'"
- "Is the name 'archive2024' free for a new file share in 'WestUS'?"
- "Verify whether 'clientdocs' can be used as a file share name in location 'centralus'"
| Parameter | Required or optional | Description |
|---|---|---|
| Name | Required | The name of the file share. |
| Location | Required | The Azure region/location name (for example, EastUS, WestEurope). |
Destructive: ❌ | Idempotent: ✅ | Open World: ❌ | Read Only: ✅ | Secret: ❌ | Local Required: ❌
File Share: Create file share
Create a new Azure file share resource in a resource group. This operation creates a high-performance, fully managed file share accessible via NFS protocol.
Example prompts include:
- "Create a new file share named 'project-data' in resource group 'rg-prod' at location 'eastus'"
- "I need to create a file share called 'backupshare' in resource group 'rg-backup' at location 'westeurope'"
- "Set up a file share 'userdocs' in resource group 'rg-dev' at location 'centralus'"
- "Create the file share 'archive2024' in resource group 'rg-archive' at location 'eastus2'"
- "Generate a file share named 'mediafiles' in resource group 'rg-media' at location 'westus'"
| Parameter | Required or optional | Description |
|---|---|---|
| Resource group | Required | The name of the Azure resource group. The resource group is a logical container for Azure resources. |
| Name | Required | The name of the file share. |
| Location | Required | The Azure region/location name (for example, EastUS, WestEurope). |
| Mount name | Optional | The mount name of the file share as seen by end users. |
| Media tier | Optional | The storage media tier (for example, SSD). |
| Redundancy | Optional | The redundancy level (for example, Local, Zone). |
| Protocol | Optional | The file sharing protocol (for example, NFS). |
| Provisioned storage in GiB (gibibytes) | Optional | The desired provisioned storage size of the share in GiB. |
| Provisioned io per sec | Optional | The provisioned IO operations per second. |
| Provisioned throughput in MiB per sec (mebibytes) | Optional | The provisioned throughput in MiB per second. |
| Public network access | Optional | Public network access setting (Enabled or Disabled). |
| Nfs root squash | Optional | NFS root squash setting (NoRootSquash, RootSquash, or AllSquash). |
| Allowed subnets | Optional | Comma-separated list of subnet IDs allowed to access the file share. |
| Tags | Optional | Resource tags as JSON (for example, {"key1":"value1","key2":"value2"}). |
Destructive: ✅ | Idempotent: ❌ | Open World: ❌ | Read Only: ❌ | Secret: ❌ | Local Required: ❌
File Share: Get file share
Get details of a specific file share or list all file shares. If name is provided, return a specific file share; otherwise, lists all file shares in the subscription or resource group.
Example prompts include:
- "Show me all file shares in storage account 'dataaccount01'"
- "List every file share available under the storage account 'backupstorage99'"
- "Get details for the file share 'reports2024' in storage account 'filesacctprod'"
- "Can you retrieve information on file share 'archive-logs' for storage account 'filestorageeast'"
- "I need to see the file share 'projectfiles' from storage account 'devstorageacct'"
| Parameter | Required or optional | Description |
|---|---|---|
| Name | Optional | The name of the file share. |
Destructive: ❌ | Idempotent: ✅ | Open World: ❌ | Read Only: ✅ | Secret: ❌ | Local Required: ❌
File Share: Update file share
Update an existing Azure file share resource. Allows updating mutable properties like provisioned storage, IOPS, throughput, and network access settings.
Example prompts include:
- "Update the file share named 'projectdocs' in storage account 'storageacct01' to modify its quota"
- "Make changes to the file share 'shareddata' within storage account 'filescanstorage' by updating access tiers"
- "Apply new settings to all file shares in storage account 'datahubstorage' at once"
- "Change configuration settings for every file share in storage account 'prodstorageacct'"
- "I need to update the file share 'reports2024' on storage account 'corpfilesstorage'"
| Parameter | Required or optional | Description |
|---|---|---|
| Resource group | Required | The name of the Azure resource group. The resource group is a logical container for Azure resources. |
| Name | Required | The name of the file share. |
| Provisioned storage in GiB (gibibytes) | Optional | The desired provisioned storage size of the share in GiB. |
| Provisioned io per sec | Optional | The provisioned IO operations per second. |
| Provisioned throughput in MiB per sec (mebibytes) | Optional | The provisioned throughput in MiB per second. |
| Public network access | Optional | Public network access setting (Enabled or Disabled). |
| Nfs root squash | Optional | NFS root squash setting (NoRootSquash, RootSquash, or AllSquash). |
| Allowed subnets | Optional | Comma-separated list of subnet IDs allowed to access the file share. |
| Tags | Optional | Resource tags as JSON (for example, {"key1":"value1","key2":"value2"}). |
Destructive: ✅ | Idempotent: ❌ | Open World: ❌ | Read Only: ❌ | Secret: ❌ | Local Required: ❌
File Share: Delete file share
Delete a file share permanently. This operation can't be undone.
Example prompts include:
- "Delete the file share named 'backup-share' in resource group 'rg-prod'"
- "Remove the file share 'project-files' in resource group 'rg-marketing'"
- "I want to delete the file share 'temp-data' in resource group 'rg-dev'"
- "Can you delete the file share 'archive-old' in resource group 'rg-archive'?"
- "Remove the file share 'cleanup-share' from resource group 'rg-cleanup'"
| Parameter | Required or optional | Description |
|---|---|---|
| Resource group | Required | The name of the Azure resource group. The resource group is a logical container for Azure resources. |
| Name | Required | The name of the file share. |
Destructive: ✅ | Idempotent: ❌ | Open World: ❌ | Read Only: ❌ | Secret: ❌ | Local Required: ❌
File Share Snapshot: Create snapshot
Create a snapshot of an Azure file share. Snapshots are read-only point-in-time copies used for backup and recovery.
Example prompts include:
- "Create a snapshot named 'backup-snap-jan23' for file share 'backups' in resource group 'rg-data-prod'"
- "I want to create a snapshot called 'project-snapshot' for the file share 'projectfiles' in resource group 'rg-marketing'"
- "Generate a snapshot named 'weekly-backup' for file share 'companyshare' in resource group 'rg-finance'"
- "Create a snapshot called 'reports-snapshot' on the file share 'reports' in resource group 'rg-analytics'"
- "Initiate snapshot creation named 'dev-snapshot-01' for file share 'devfiles' in resource group 'rg-development'"
| Parameter | Required or optional | Description |
|---|---|---|
| Resource group | Required | The name of the Azure resource group. The resource group is a logical container for Azure resources. |
| File share name | Required | The name of the parent file share. |
| Snapshot name | Required | The name of the snapshot. |
| Metadata | Optional | Custom metadata for the snapshot as a JSON object (for example, {"key1":"value1","key2":"value2"}). |
Destructive: ✅ | Idempotent: ❌ | Open World: ❌ | Read Only: ❌ | Secret: ❌ | Local Required: ❌
File Share Snapshot: Get snapshot
Get details of a specific file share snapshot or list all snapshots. If the `snapshot name is provided, return a specific snapshot; otherwise, lists all snapshots for the file share.
Example prompts include:
- "Show me all snapshots for file share 'projectfileshare' in resource group 'rg-prod'"
- "List snapshots available on the file share 'teamdata' in resource group 'rg-finance'"
- "Get the snapshot named 'snapshot20240601' from file share 'backupshare' in resource group 'rg-backup'"
- "Retrieve details for the snapshot 'dailybackup' on file share 'reports' in resource group 'rg-analytics'"
- "I need to see the snapshot 'weekendcopy' from file share 'mediafiles' in resource group 'rg-media'"
| Parameter | Required or optional | Description |
|---|---|---|
| Resource group | Required | The name of the Azure resource group. The resource group is a logical container for Azure resources. |
| File share name | Required | The name of the parent file share. |
| Snapshot name | Optional | The name of the snapshot. |
Destructive: ❌ | Idempotent: ✅ | Open World: ❌ | Read Only: ✅ | Secret: ❌ | Local Required: ❌
File Share Snapshot: Update snapshot
Update properties and metadata of an Azure file share snapshot, such as tags or retention policies.
Example prompts include:
- "Update the snapshot 'backup-snap-jan23' for file share 'backupshare' in resource group 'rg-backup'"
- "Apply updates to snapshot 'data-snapshot' on file share 'datafiles' in resource group 'rg-data'"
- "Can you update snapshot 'snapshot2024' for file share 'reports' in resource group 'rg-analytics'"
- "Update the snapshot named 'endofmonth' on file share 'finance-data' in resource group 'rg-finance'"
- "Modify the properties of snapshot 'weeklybackup' for file share 'devfileshare' in resource group 'rg-dev'"
| Parameter | Required or optional | Description |
|---|---|---|
| Resource group | Required | The name of the Azure resource group. The resource group is a logical container for Azure resources. |
| File share name | Required | The name of the parent file share. |
| Snapshot name | Required | The name of the snapshot. |
| Metadata | Optional | Custom metadata for the snapshot as a JSON object (for example, {"key1":"value1","key2":"value2"}). |
Destructive: ✅ | Idempotent: ❌ | Open World: ❌ | Read Only: ❌ | Secret: ❌ | Local Required: ❌
File Share Snapshot: Delete snapshot
Delete a file share snapshot permanently. This operation can't be undone.
Example prompts include:
- "Delete snapshot 'backup-snap-jan15' from file share 'datafiles' in resource group 'rg-prod'"
- "Remove snapshot 'weekly-backup' from file share 'backupshare' in resource group 'rg-backup'"
- "Delete snapshot 'snapshot2024-03-15' from file share 'reports' in resource group 'rg-analytics'"
- "Delete the snapshot 'dailybackup' from file share 'projectfiles' in resource group 'rg-dev'"
- "Remove snapshot 'weeklysnap' from file share 'archive' in resource group 'rg-archive'"
| Parameter | Required or optional | Description |
|---|---|---|
| Resource group | Required | The name of the Azure resource group. This is a logical container for Azure resources. |
| File share name | Required | The name of the parent file share. |
| Snapshot name | Required | The name of the snapshot. |
Destructive: ✅ | Idempotent: ❌ | Open World: ❌ | Read Only: ❌ | Secret: ❌ | Local Required: ❌