Files interface
Interface representing a Files.
Methods
| create |
The PUT method creates a new file or updates an existing one. |
| delete(string, string, string, string, Files |
This method deletes a file. |
| get(string, string, string, string, Files |
The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file. |
| list(string, string, string, Files |
The project resource is a nested resource representing a stored migration project. This method returns a list of files owned by a project resource. |
| read(string, string, string, string, Files |
This method is used for requesting storage information using which contents of the file can be downloaded. |
| read |
This method is used for requesting information for reading and writing the file content. |
| update(string, string, string, string, Project |
This method updates an existing file. |
Method Details
createOrUpdate(string, string, string, string, ProjectFile, FilesCreateOrUpdateOptionalParams)
The PUT method creates a new file or updates an existing one.
function createOrUpdate(groupName: string, serviceName: string, projectName: string, fileName: string, parameters: ProjectFile, options?: FilesCreateOrUpdateOptionalParams): Promise<ProjectFile>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- fileName
-
string
Name of the File
- parameters
- ProjectFile
Information about the file
The options parameters.
Returns
Promise<ProjectFile>
delete(string, string, string, string, FilesDeleteOptionalParams)
This method deletes a file.
function delete(groupName: string, serviceName: string, projectName: string, fileName: string, options?: FilesDeleteOptionalParams): Promise<void>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- fileName
-
string
Name of the File
- options
- FilesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, FilesGetOptionalParams)
The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file.
function get(groupName: string, serviceName: string, projectName: string, fileName: string, options?: FilesGetOptionalParams): Promise<ProjectFile>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- fileName
-
string
Name of the File
- options
- FilesGetOptionalParams
The options parameters.
Returns
Promise<ProjectFile>
list(string, string, string, FilesListOptionalParams)
The project resource is a nested resource representing a stored migration project. This method returns a list of files owned by a project resource.
function list(groupName: string, serviceName: string, projectName: string, options?: FilesListOptionalParams): PagedAsyncIterableIterator<ProjectFile, ProjectFile[], PageSettings>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- options
- FilesListOptionalParams
The options parameters.
Returns
read(string, string, string, string, FilesReadOptionalParams)
This method is used for requesting storage information using which contents of the file can be downloaded.
function read(groupName: string, serviceName: string, projectName: string, fileName: string, options?: FilesReadOptionalParams): Promise<FileStorageInfo>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- fileName
-
string
Name of the File
- options
- FilesReadOptionalParams
The options parameters.
Returns
Promise<FileStorageInfo>
readWrite(string, string, string, string, FilesReadWriteOptionalParams)
This method is used for requesting information for reading and writing the file content.
function readWrite(groupName: string, serviceName: string, projectName: string, fileName: string, options?: FilesReadWriteOptionalParams): Promise<FileStorageInfo>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- fileName
-
string
Name of the File
- options
- FilesReadWriteOptionalParams
The options parameters.
Returns
Promise<FileStorageInfo>
update(string, string, string, string, ProjectFile, FilesUpdateOptionalParams)
This method updates an existing file.
function update(groupName: string, serviceName: string, projectName: string, fileName: string, parameters: ProjectFile, options?: FilesUpdateOptionalParams): Promise<ProjectFile>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- fileName
-
string
Name of the File
- parameters
- ProjectFile
Information about the file
- options
- FilesUpdateOptionalParams
The options parameters.
Returns
Promise<ProjectFile>
Azure SDK for JavaScript