{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Files: API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Files:", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Gets A List Of All Files Owned By The Azure Openai Resource \r\nthese Include User Uploaded Content Like Files With Purpose \"fine Tune\" For Training Or Validation Of Fine Tunes Models\r\nas Well As Files That Are Generated By The Service Such As \"fine Tune Results\" Which Contains Various Metrics For The Corresponding Fine Tune Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "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", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets Details For A Single File Specified By The Given File Id Including Status, Size, Purpose, Etc", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id", "params": [ { "name": "file_id", "value": "", "type": "path", "description": "The identifier of the file." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Deletes The File With The Given File Id \r\ndeletion Is Also Allowed If A File Was Used, E G , As Training File In A Fine Tune Job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id", "params": [ { "name": "file_id", "value": "", "type": "path", "description": "The identifier of the file." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Content Of The File Specified By The Given File Id \r\nfiles Can Be User Uploaded Content Or Generated By The Service Like Result Metrics Of A Fine Tune Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/content", "params": [ { "name": "file_id", "value": "", "type": "path", "description": "The identifier of the file." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "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", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/import", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets Details For A Single File Specified By The Given File Id Including Status, Size, Purpose, Etc", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file-id", "params": [ { "name": "file-id", "value": "", "type": "path", "description": "The identifier of the file." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Deletes The File With The Given File Id \r\ndeletion Is Also Allowed If A File Was Used, E G , As Training File In A Fine Tune Job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file-id", "params": [ { "name": "file-id", "value": "", "type": "path", "description": "The identifier of the file." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Content Of The File Specified By The Given File Id \r\nfiles Can Be User Uploaded Content Or Generated By The Service Like Result Metrics Of A Fine Tune Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file-id/content", "params": [ { "name": "file-id", "value": "", "type": "path", "description": "The identifier of the file." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Files Fileid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "The ID of the file to retrieve." } ] }, "docs": "Returns information about a specific file. Does not retrieve file content." }, { "info": { "name": "Microsoft Azure Delete Files Fileid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "The ID of the file to delete." } ] }, "docs": "Delete a previously uploaded file." }, { "info": { "name": "Microsoft Azure Get Jobs Jobid Tasks Taskid Files Filepath", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "ocp-range", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job that contains the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task whose file you want to retrieve." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Task file that you want to get the content of." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Returns the content of the specified Task file." }, { "info": { "name": "Microsoft Azure Deletes The Specified Task File From The Compute Node Where The Task Ran", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job that contains the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task whose file you want to delete." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Task file or directory that you want to delete." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Head Jobs Jobid Tasks Taskid Files Filepath", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job that contains the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task whose file you want to get the properties of." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Task file that you want to get the properties of." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Gets the properties of the specified Task file." }, { "info": { "name": "Microsoft Azure Get Pools Poolid Nodes Nodeid Files Filepath", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "ocp-range", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node that contains the file." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Compute Node file that you want to get the content of." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Returns the content of the specified Compute Node file." }, { "info": { "name": "Microsoft Azure Deletes The Specified File From The Compute Node", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node from which you want to delete the file." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the file or directory that you want to delete." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Head Pools Poolid Nodes Nodeid Files Filepath", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node that contains the file." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Compute Node file that you want to get the properties of." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Gets the properties of the specified Compute Node file." }, { "info": { "name": "Microsoft Azure Lists The Files In A Task S Directory On Its Compute Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job that contains the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task whose files you want to list." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Lists All Of The Files In Task Directories On The Specified Compute Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/pools/:poolId/nodes/:nodeId/files", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The ID of the Pool that contains the Compute Node." }, { "name": "nodeId", "value": "", "type": "path", "description": "The ID of the Compute Node whose files you want to list." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to list children of a directory." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File Workspace Name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Azure subscription Id." }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "Lists all the Files information under a workspace for an Azure subscription." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Support Fileworkspaces Fileworkspacename Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File Workspace Name" }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "Lists all the Files information under a workspace for an Azure subscription." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files/:fileName", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File Workspace Name" }, { "name": "fileName", "value": "", "type": "path", "description": "File Name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Azure subscription Id." }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "Returns details of a specific file in a work space." }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files/:fileName", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File workspace name." }, { "name": "fileName", "value": "", "type": "path", "description": "File name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Azure subscription Id." }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "Creates a new file under a workspace for the specified subscription." }, { "info": { "name": "Microsoft Azure Get Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files/:fileName", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File Workspace Name" }, { "name": "fileName", "value": "", "type": "path", "description": "File Name" }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "Returns details of a specific file in a work space." }, { "info": { "name": "Microsoft Azure Put Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files/:fileName", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File workspace name." }, { "name": "fileName", "value": "", "type": "path", "description": "File name." }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "Creates a new file under a workspace." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename Upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files/:fileName/upload", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File WorkspaceName" }, { "name": "fileName", "value": "", "type": "path", "description": "File Name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Azure subscription Id." }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "This API allows you to upload content to a file" }, { "info": { "name": "Microsoft Azure Post Providers Microsoft Support Fileworkspaces Fileworkspacename Files Filename Upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/Microsoft.Support/fileWorkspaces/:fileWorkspaceName/files/:fileName/upload", "params": [ { "name": "fileWorkspaceName", "value": "", "type": "path", "description": "File WorkspaceName" }, { "name": "fileName", "value": "", "type": "path", "description": "File Name" }, { "name": "api-version", "value": "", "type": "query", "description": "API version." } ] }, "docs": "This API allows you to upload content to a file" } ] } ], "bundled": true }