FilesOperations Class

FilesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

FilesOperations

Constructor

FilesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_or_update	Create a file resource. The PUT method creates a new file or updates an existing one.
delete	Delete file. This method deletes a file.
get	Get file information. 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	Get files in a project. 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	Request storage information for downloading the file content. This method is used for requesting storage information using which contents of the file can be downloaded.
read_write	Request information for reading and writing file content. This method is used for requesting information for reading and writing the file content.
update	Update a file. This method updates an existing file.

create_or_update

Create a file resource.

The PUT method creates a new file or updates an existing one.

create_or_update(group_name: str, service_name: str, project_name: str, file_name: str, parameters: _models.ProjectFile, **kwargs: Any) -> _models.ProjectFile

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

file_name

str

Required

Name of the File.

parameters

ProjectFile

Required

Information about the file.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProjectFile, or the result of cls(response)

Return type

ProjectFile

Exceptions

HttpResponseError

delete

Delete file.

This method deletes a file.

delete(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) -> None

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

file_name

str

Required

Name of the File.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get file information.

The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file.

get(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) -> _models.ProjectFile

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

file_name

str

Required

Name of the File.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProjectFile, or the result of cls(response)

Return type

ProjectFile

Exceptions

HttpResponseError

list

Get files in a project.

The project resource is a nested resource representing a stored migration project. This method returns a list of files owned by a project resource.

list(group_name: str, service_name: str, project_name: str, **kwargs: Any) -> Iterable[_models.FileList]

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either FileList or the result of cls(response)

Return type

ItemPaged[FileList]

Exceptions

HttpResponseError

read

Request storage information for downloading the file content.

This method is used for requesting storage information using which contents of the file can be downloaded.

read(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) -> _models.FileStorageInfo

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

file_name

str

Required

Name of the File.

cls

callable

A custom type or function that will be passed the direct response

Returns

FileStorageInfo, or the result of cls(response)

Return type

FileStorageInfo

Exceptions

HttpResponseError

read_write

Request information for reading and writing file content.

This method is used for requesting information for reading and writing the file content.

read_write(group_name: str, service_name: str, project_name: str, file_name: str, **kwargs: Any) -> _models.FileStorageInfo

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

file_name

str

Required

Name of the File.

cls

callable

A custom type or function that will be passed the direct response

Returns

FileStorageInfo, or the result of cls(response)

Return type

FileStorageInfo

Exceptions

HttpResponseError

update

Update a file.

This method updates an existing file.

update(group_name: str, service_name: str, project_name: str, file_name: str, parameters: _models.ProjectFile, **kwargs: Any) -> _models.ProjectFile

Parameters

group_name

str

Required

Name of the resource group.

service_name

str

Required

Name of the service.

project_name

str

Required

Name of the project.

file_name

str

Required

Name of the File.

parameters

ProjectFile

Required

Information about the file.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProjectFile, or the result of cls(response)

Return type

ProjectFile

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.datamigration.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datamigration\\models\\__init__.py'>