Operations on the FileService resource

  • Article

The FileService resource exposes specific management settings that apply to all the file shares in the storage account. The FileService resource is a child of the storage account resource, and a storage account has only one FileService resource, which is called default.

You can interact with the FileService resource in two ways:

  • (Recommended) The storage resource provider (Microsoft.Storage), which provides a control plane API to manage through Azure Resource Manager.
  • (Legacy) The FileREST API, which provides additional HTTPS endpoints to manage the FileService resource.

Unless you have a specific reason, you should use the control plane API (the storage resource provider) for all management activities. APIs to manage the FileService resource are exposed through the data plane for legacy reasons. Data plane APIs that do management actions are fully supported, and acceptable for use in the following circumstances:

  • You have a legacy application or service that's already using these APIs.
  • You have very high scale requirements. The control plane API that's provided by the storage resource provider has much lower scale guarantees than the FileREST API.

New parameters and actions on the FileService resource may not be added to the data plane REST SDKs, even if they're exposed in FileREST. Use the control plane SDKs to access the parameters and actions.

To learn more about the Azure Files API surface area, see Azure Files REST API.

Management APIs

This section contains the following topics.

Action Control plane API (Microsoft.Storage) Data plane API (FileREST) Available on SMB file shares Available on NFS file shares
Get FileService - File Services - Get Service Properties
- File Services - List		 Get File Service Properties Yes Yes
Set FileService File Services - Set Service Properties Set File Service Properties Yes Yes
Preflight File Request -- Preflight File Request Yes Yes

See also