# Azure Files File API

**Canonical:** https://apis.io/apis/azure-file-storage/azure-file-storage-file-api/  
**Provider:** Azure Files — https://apis.io/providers/azure-file-storage/  
**Base URL:** https://{account-name}.file.core.windows.net  
**Documentation:** https://learn.microsoft.com/en-us/rest/api/storageservices/file-service-rest-api

Azure Files File API is one of 10 APIs that [Azure Files](https://apis.io/providers/azure-file-storage/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

The file API from Azure Files — 17 operation(s) for file.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| PUT | `/{shareName}/{directory}/{fileName}` | File create |
| GET | `/{shareName}/{directory}/{fileName}` | File download |
| HEAD | `/{shareName}/{directory}/{fileName}` | File get properties |
| DELETE | `/{shareName}/{directory}/{fileName}` | File delete |
| PUT | `/{shareName}/{directory}/{fileName}?comp=properties` | File set HTTP headers |
| PUT | `/{shareName}/{directory}/{fileName}?comp=metadata` | File set metadata |
| PUT | `/{shareName}/{directory}/{fileName}?comp=lease&acquire` | File acquire lease |
| PUT | `/{shareName}/{directory}/{fileName}?comp=lease&release` | File release lease |
| PUT | `/{shareName}/{directory}/{fileName}?comp=lease&change` | File change lease |
| PUT | `/{shareName}/{directory}/{fileName}?comp=lease&break` | File break lease |
| PUT | `/{shareName}/{directory}/{fileName}?comp=range` | File upload range |
| PUT | `/{shareName}/{directory}/{fileName}?comp=range&fromURL` | File upload range from URL |
| GET | `/{shareName}/{directory}/{fileName}?comp=rangelist` | File get range list |
| PUT | `/{shareName}/{directory}/{fileName}?comp=copy` | File start copy |
| PUT | `/{shareName}/{directory}/{fileName}?comp=copy&copyid` | File abort copy |
| GET | `/{shareName}/{directory}/{fileName}?comp=listhandles` | File list handles |
| PUT | `/{shareName}/{directory}/{fileName}?comp=forceclosehandles` | File force close handles |
| PUT | `/{shareName}/{directory}/{fileName}?comp=rename` | File rename |
| PUT | `/{shareName}/{directory}/{fileName}?restype=symboliclink` | File create symbolic link |
| GET | `/{shareName}/{directory}/{fileName}?restype=symboliclink` | File get symbolic link |
| PUT | `/{shareName}/{directory}/{fileName}?restype=hardlink` | File create hard link |

## Machine-readable artifacts (10)

- **OpenAPI** — https://artifacts.apis.io/azure-file-storage/openapi/azure-file-storage-file-api-openapi.yml
- **Documentation** — https://learn.microsoft.com/en-us/rest/api/storageservices/file-service-rest-api
- **Operations on Shares** — https://learn.microsoft.com/en-us/rest/api/storageservices/operations-on-shares--file-service-
- **Operations on Files** — https://learn.microsoft.com/en-us/rest/api/storageservices/operations-on-files
- **JSONSchema** — https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-user-delegation-key-schema.json
- **JSONSchema** — https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-list-files-and-directories-segment-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-storage-service-properties-schema.json
- **JSONSchema** — https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-list-shares-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-key-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-share-permission-schema.json

## Other Azure Files APIs (9)

- [Azure Storage Resource Provider API (File Services / Shares)](https://apis.io/apis/azure-file-storage/storage-rp-api/)
- [Azure Files Account API](https://apis.io/apis/azure-file-storage/azure-file-storage-account-api/)
- [Azure Files Directories API](https://apis.io/apis/azure-file-storage/azure-file-storage-directories-api/)
- [Azure Files API](https://apis.io/apis/azure-file-storage/azure-file-storage-files-api/)
- [Azure Files Shares API](https://apis.io/apis/azure-file-storage/azure-file-storage-shares-api/)
- [Azure File Storage Shares API](https://apis.io/apis/azure-file-storage/microsoft-azure-file-storage-shares-api/)
- [Azure Files Directory API](https://apis.io/apis/azure-file-storage/azure-file-storage-directory-api/)
- [Azure Files Service API](https://apis.io/apis/azure-file-storage/azure-file-storage-service-api/)
- [Azure Files Share API](https://apis.io/apis/azure-file-storage/azure-file-storage-share-api/)

## Tags

File

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/azure-file-storage/azure-file-storage-file-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/azure-file-storage/.