Files interface

Package:

@azure/arm-support

Interface representing a Files.

Methods

create(string, string, FileDetails, FilesCreateOptionalParams)	Creates a new file under a workspace for the specified subscription.
get(string, string, FilesGetOptionalParams)	Returns details of a specific file in a work space.
list(string, FilesListOptionalParams)	Lists all the Files information under a workspace for an Azure subscription.
upload(string, string, UploadFile, FilesUploadOptionalParams)	This API allows you to upload content to a file

Method Details

create(string, string, FileDetails, FilesCreateOptionalParams)

Creates a new file under a workspace for the specified subscription.

function create(fileWorkspaceName: string, fileName: string, createFileParameters: FileDetails, options?: FilesCreateOptionalParams): Promise<FileDetails>

Parameters

fileWorkspaceName

string

File workspace name.

fileName

string

File name.

createFileParameters

FileDetails

Create file object

options

FilesCreateOptionalParams

The options parameters.

Returns

Promise<FileDetails>

get(string, string, FilesGetOptionalParams)

Returns details of a specific file in a work space.

function get(fileWorkspaceName: string, fileName: string, options?: FilesGetOptionalParams): Promise<FileDetails>

Parameters

fileWorkspaceName

string

File Workspace Name

fileName

string

File Name

options

FilesGetOptionalParams

The options parameters.

Returns

Promise<FileDetails>

list(string, FilesListOptionalParams)

Lists all the Files information under a workspace for an Azure subscription.

function list(fileWorkspaceName: string, options?: FilesListOptionalParams): PagedAsyncIterableIterator<FileDetails, FileDetails[], PageSettings>

Parameters

fileWorkspaceName

string

File Workspace Name

options

FilesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FileDetails, FileDetails[], PageSettings>

upload(string, string, UploadFile, FilesUploadOptionalParams)

This API allows you to upload content to a file

function upload(fileWorkspaceName: string, fileName: string, uploadFile: UploadFile, options?: FilesUploadOptionalParams): Promise<void>

Parameters

fileWorkspaceName

string

File WorkspaceName

fileName

string

File Name

uploadFile

UploadFile

UploadFile object

options

FilesUploadOptionalParams

The options parameters.

Returns

Promise<void>