How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Files: API

The Files: API from Microsoft Azure — 17 operation(s) for files:.

Microsoft Azure Files: API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 27 operations across 17 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

27 operations 17 paths 28 schemas 5 DELETE14 GET2 HEAD4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 27

Across 17 paths, the API surfaces 27 operations — 5 DELETE, 14 GET, 2 HEAD, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Files: 27
GET
/files
Microsoft Azure Gets A List Of All Files Owned By The Azure Openai Resource these Include User Uploaded Content Like Files With Purpose "fine Tune" For Training Or Validation Of Fine Tunes Models as…
microsoftAzureFilesList 1 param → 200default
POST
/files
Microsoft Azure Creates A New File Entity By Uploading Data From A Local Machine Uploaded Files Can, For Example, Be Used For Training Or Evaluating Fine Tuned Models
microsoftAzureFilesUpload 1 param body → 201default
GET
/files/{file_id}
Microsoft Azure Gets Details For A Single File Specified By The Given File Id Including Status, Size, Purpose, Etc
microsoftAzureFilesGet 2 params → 200default
DELETE
/files/{file_id}
Microsoft Azure Deletes The File With The Given File Id deletion Is Also Allowed If A File Was Used, E G , As Training File In A Fine Tune Job
microsoftAzureFilesDelete 2 params → 204default
GET
/files/{file_id}/content
Microsoft Azure Gets The Content Of The File Specified By The Given File Id files Can Be User Uploaded Content Or Generated By The Service Like Result Metrics Of A Fine Tune Job
microsoftAzureFilesGetfilecontent 2 params → 200default
POST
/files/import
Microsoft Azure Creates A New File Entity By Importing Data From A Provided Url Uploaded Files Can, For Example, Be Used For Training Or Evaluating Fine Tuned Models
microsoftAzureFilesImport 1 param body → 201default
GET
/files/{file-id}
Microsoft Azure Gets Details For A Single File Specified By The Given File Id Including Status, Size, Purpose, Etc
microsoftAzureFilesGet 2 params → 200default
DELETE
/files/{file-id}
Microsoft Azure Deletes The File With The Given File Id deletion Is Also Allowed If A File Was Used, E G , As Training File In A Fine Tune Job
microsoftAzureFilesDelete 2 params → 204default
GET
/files/{file-id}/content
Microsoft Azure Gets The Content Of The File Specified By The Given File Id files Can Be User Uploaded Content Or Generated By The Service Like Result Metrics Of A Fine Tune Job
microsoftAzureFilesGetcontent 2 params → 200default
GET
/files/{fileId}
Microsoft Azure Get Files Fileid
microsoftAzureRetrievefile 1 param → 200
DELETE
/files/{fileId}
Microsoft Azure Delete Files Fileid
microsoftAzureDeletefile 1 param → 200
DELETE
/jobs/{jobId}/tasks/{taskId}/files/{filePath}
Microsoft Azure Deletes The Specified Task File From The Compute Node Where The Task Ran
microsoftAzureFileDeletefromtask 9 params → 200default
GET
/jobs/{jobId}/tasks/{taskId}/files/{filePath}
Microsoft Azure Get Jobs Jobid Tasks Taskid Files Filepath
microsoftAzureFileGetfromtask 11 params → 200default
HEAD
/jobs/{jobId}/tasks/{taskId}/files/{filePath}
Microsoft Azure Head Jobs Jobid Tasks Taskid Files Filepath
microsoftAzureFileGetpropertiesfromtask 10 params → 200default
DELETE
/pools/{poolId}/nodes/{nodeId}/files/{filePath}
Microsoft Azure Deletes The Specified File From The Compute Node
microsoftAzureFileDeletefromcomputenode 9 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/files/{filePath}
Microsoft Azure Get Pools Poolid Nodes Nodeid Files Filepath
microsoftAzureFileGetfromcomputenode 11 params → 200default
HEAD
/pools/{poolId}/nodes/{nodeId}/files/{filePath}
Microsoft Azure Head Pools Poolid Nodes Nodeid Files Filepath
microsoftAzureFileGetpropertiesfromcomputenode 10 params → 200default
GET
/jobs/{jobId}/tasks/{taskId}/files
Microsoft Azure Lists The Files In A Task S Directory On Its Compute Node
microsoftAzureFileListfromtask 10 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/files
Microsoft Azure Lists All Of The Files In Task Directories On The Specified Compute Node
microsoftAzureFileListfromcomputenode 10 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files
microsoftAzureFilesList 3 params → 200default
GET
/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files
Microsoft Azure Get Providers Microsoft Support Fileworkspaces Fileworkspacename Files
microsoftAzureFilesnosubscriptionList 2 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename
microsoftAzureFilesGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename
microsoftAzureFilesCreate 4 params body → 201default
GET
/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
Microsoft Azure Get Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename
microsoftAzureFilesnosubscriptionGet 3 params → 200default
PUT
/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}
Microsoft Azure Put Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename
microsoftAzureFilesnosubscriptionCreate 3 params body → 201default
POST
/subscriptions/{subscriptionId}/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename Upload
microsoftAzureFilesUpload 4 params body → 204default
POST
/providers/Microsoft.Support/fileWorkspaces/{fileWorkspaceName}/files/{fileName}/upload
Microsoft Azure Post Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename Upload
microsoftAzureFilesnosubscriptionUpload 3 params body → 204default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are File_2 (10 properties), File (8 properties), OpenAIFile (6 properties), Error (5 properties). Each schema is shown below with its type and property counts.

File_2
object
A file is a document usable for training and validation. It can also be a service generated document with result details.
10 properties 2 required
ErrorMessage
object
2 properties
Error
object
Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
5 properties 2 required
FileDetails
object
Object that represents File Details resource
1 property
ErrorResponse_2
object
Error response as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
1 property 1 required
FileProperties
object
5 properties 2 required
InnerErrorCode
string
Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-respons…
FilePurpose
string
The possible values denoting the intended usage of a file.
FileImport
object
Defines a document to import from an external content url to be usable with Azure OpenAI.
3 properties 3 required
ErrorCode
string
Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
InnerError
object
Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
2 properties
FileDeletionStatus
object
A status response from a file deletion operation.
3 properties 3 required
FilesListResult
object
Object that represents a collection of File resources.
2 properties
FileList
object
Represents a list of files.
2 properties
FileDetailsProperties
object
Describes the properties of a file.
4 properties
State_2
string
The state of a job or item.
BatchError
object
3 properties
Purpose
string
The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file.
UploadFile
object
File content associated with the file under a workspace.
2 properties
State
string
The state of a job or item.
ErrorResponse
object
Error response as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
1 property
FileStatistics
object
A file is a document usable for training and validation. It can also be a service generated document with result details.
2 properties
NodeFile
object
4 properties
TypeDiscriminator
string
Defines the type of an object.
BatchErrorDetail
object
2 properties
NodeFileListResult
object
2 properties
File
object
A file is a document usable for training and validation. It can also be a service generated document with result details.
8 properties 2 required
OpenAIFile
object
Represents an assistant that can call the model and use tools.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-files-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Files: API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.