Files class
Class representing a Files.
Constructors
| Files(Data |
Create a Files. |
Methods
Constructor Details
Files(DataMigrationServiceClientContext)
Create a Files.
new Files(client: DataMigrationServiceClientContext)Parameters
Reference to the service client.
Method Details
createOrUpdate(ProjectFile, string, string, string, string, RequestOptionsBase)
The PUT method creates a new file or updates an existing one.
function createOrUpdate(parameters: ProjectFile, groupName: string, serviceName: string, projectName: string, fileName: string, options?: RequestOptionsBase): Promise<FilesCreateOrUpdateResponse>Parameters
- parameters
- ProjectFile
Information about the file
- 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
- RequestOptionsBase
The optional parameters
Returns
Promise<FilesCreateOrUpdateResponse>
Promise<Models.FilesCreateOrUpdateResponse>
createOrUpdate(ProjectFile, string, string, string, string, RequestOptionsBase, ServiceCallback<ProjectFile>)
function createOrUpdate(parameters: ProjectFile, groupName: string, serviceName: string, projectName: string, fileName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectFile>)Parameters
- parameters
- ProjectFile
Information about the file
- 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
- RequestOptionsBase
The optional parameters
- callback
The callback
createOrUpdate(ProjectFile, string, string, string, string, ServiceCallback<ProjectFile>)
function createOrUpdate(parameters: ProjectFile, groupName: string, serviceName: string, projectName: string, fileName: string, callback: ServiceCallback<ProjectFile>)Parameters
- parameters
- ProjectFile
Information about the file
- 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
- callback
The callback
deleteMethod(string, string, string, string, RequestOptionsBase)
This method deletes a file.
function deleteMethod(groupName: string, serviceName: string, projectName: string, fileName: string, options?: RequestOptionsBase): Promise<RestResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(groupName: string, serviceName: string, projectName: string, fileName: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, string, string, ServiceCallback<void>)
function deleteMethod(groupName: string, serviceName: string, projectName: string, fileName: string, callback: ServiceCallback<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
- callback
-
ServiceCallback<void>
The callback
get(string, string, string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<FilesGetResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<FilesGetResponse>
Promise<Models.FilesGetResponse>
get(string, string, string, string, RequestOptionsBase, ServiceCallback<ProjectFile>)
function get(groupName: string, serviceName: string, projectName: string, fileName: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, string, string, ServiceCallback<ProjectFile>)
function get(groupName: string, serviceName: string, projectName: string, fileName: string, callback: ServiceCallback<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
- callback
The callback
list(string, string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<FilesListResponse>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<FilesListResponse>
Promise<Models.FilesListResponse>
list(string, string, string, RequestOptionsBase, ServiceCallback<FileList>)
function list(groupName: string, serviceName: string, projectName: string, options: RequestOptionsBase, callback: ServiceCallback<FileList>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
list(string, string, string, ServiceCallback<FileList>)
function list(groupName: string, serviceName: string, projectName: string, callback: ServiceCallback<FileList>)Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- projectName
-
string
Name of the project
- callback
The callback
listNext(string, RequestOptionsBase)
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 listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<FilesListNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<FilesListNextResponse>
Promise<Models.FilesListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<FileList>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<FileList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listNext(string, ServiceCallback<FileList>)
function listNext(nextPageLink: string, callback: ServiceCallback<FileList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
read(string, string, string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<FilesReadResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<FilesReadResponse>
Promise<Models.FilesReadResponse>
read(string, string, string, string, RequestOptionsBase, ServiceCallback<FileStorageInfo>)
function read(groupName: string, serviceName: string, projectName: string, fileName: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
The callback
read(string, string, string, string, ServiceCallback<FileStorageInfo>)
function read(groupName: string, serviceName: string, projectName: string, fileName: string, callback: ServiceCallback<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
- callback
The callback
readWrite(string, string, string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<FilesReadWriteResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<FilesReadWriteResponse>
Promise<Models.FilesReadWriteResponse>
readWrite(string, string, string, string, RequestOptionsBase, ServiceCallback<FileStorageInfo>)
function readWrite(groupName: string, serviceName: string, projectName: string, fileName: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
The callback
readWrite(string, string, string, string, ServiceCallback<FileStorageInfo>)
function readWrite(groupName: string, serviceName: string, projectName: string, fileName: string, callback: ServiceCallback<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
- callback
The callback
update(ProjectFile, string, string, string, string, RequestOptionsBase)
This method updates an existing file.
function update(parameters: ProjectFile, groupName: string, serviceName: string, projectName: string, fileName: string, options?: RequestOptionsBase): Promise<FilesUpdateResponse>Parameters
- parameters
- ProjectFile
Information about the file
- 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
- RequestOptionsBase
The optional parameters
Returns
Promise<FilesUpdateResponse>
Promise<Models.FilesUpdateResponse>
update(ProjectFile, string, string, string, string, RequestOptionsBase, ServiceCallback<ProjectFile>)
function update(parameters: ProjectFile, groupName: string, serviceName: string, projectName: string, fileName: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectFile>)Parameters
- parameters
- ProjectFile
Information about the file
- 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
- RequestOptionsBase
The optional parameters
- callback
The callback
update(ProjectFile, string, string, string, string, ServiceCallback<ProjectFile>)
function update(parameters: ProjectFile, groupName: string, serviceName: string, projectName: string, fileName: string, callback: ServiceCallback<ProjectFile>)Parameters
- parameters
- ProjectFile
Information about the file
- 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
- callback
The callback