OnedriveClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnDeletedFiles': {'operation_id': 'OnDeletedFiles', 'path': '/{connectionId}/datasets/default/triggers/batch/ondeletedfile', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': 'BlobMetadata'}, 'OnNewFileV2': {'operation_id': 'OnNewFileV2', 'path': '/{connectionId}/datasets/default/triggers/onnewfilev2', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': None}, 'OnNewFilesV2': {'operation_id': 'OnNewFilesV2', 'path': '/{connectionId}/datasets/default/triggers/batch/onnewfilesv2', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': 'BlobMetadata'}, 'OnUpdatedFileV2': {'operation_id': 'OnUpdatedFileV2', 'path': '/{connectionId}/datasets/default/triggers/onupdatedfilev2', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': None}, 'OnUpdatedFilesV2': {'operation_id': 'OnUpdatedFilesV2', 'path': '/{connectionId}/datasets/default/triggers/batch/onupdatedfilesv2', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': 'BlobMetadata'}}

Classes

BlobMetadata dataclass

BlobMetadata(id: Optional[str] = None, name: Optional[str] = None, name_no_ext: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, last_modified: Optional[str] = None, size: Optional[int] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, e_tag: Optional[str] = None, file_locator: Optional[str] = None, last_modified_by: Optional[str] = None)

Response for Get file metadata

Attributes

id class-attribute instance-attribute

id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The unique identifier of the file or folder.

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the file or folder.

name_no_ext class-attribute instance-attribute

name_no_ext: Optional[str] = field(default=None, metadata={'wire_name': 'NameNoExt'})

The name of the file or folder, without the file extension.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the file or folder.

path class-attribute instance-attribute

path: Optional[str] = field(default=None, metadata={'wire_name': 'Path'})

The path of the file or folder.

last_modified class-attribute instance-attribute

last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'LastModified'})

The date and time the file or folder was last modified.

size class-attribute instance-attribute

size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The file or folder size in bytes.

media_type class-attribute instance-attribute

media_type: Optional[str] = field(default=None, metadata={'wire_name': 'MediaType'})

The media type of the file or folder.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = field(default=None, metadata={'wire_name': 'IsFolder'})

A boolean value (true, false) to indicate whether or not the blob is a folder.

e_tag class-attribute instance-attribute

e_tag: Optional[str] = field(default=None, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute

file_locator: Optional[str] = field(default=None, metadata={'wire_name': 'FileLocator'})

The file locator of the file or folder.

last_modified_by class-attribute instance-attribute

last_modified_by: Optional[str] = field(default=None, metadata={'wire_name': 'LastModifiedBy'})

The user who last modified the file or folder.

Tags dataclass

Tags(tags: Optional[List[str]] = None)

Response for Get file tags

Attributes

tags class-attribute instance-attribute

tags: Optional[List[str]] = field(default=None, metadata={'wire_name': 'Tags'})

A list of tags.

Thumbnail dataclass

Thumbnail(url: Optional[str] = None, width: Optional[int] = None, height: Optional[int] = None)

Response for Get file thumbnail

Attributes

url class-attribute instance-attribute

url: Optional[str] = field(default=None, metadata={'wire_name': 'Url'})

A URL that points to the thumbnail.

width class-attribute instance-attribute

width: Optional[int] = field(default=None, metadata={'wire_name': 'Width'})

The thumbnail width in pixels.

height class-attribute instance-attribute

height: Optional[int] = field(default=None, metadata={'wire_name': 'Height'})

The thumbnail height in pixels.

SharingLink dataclass

SharingLink(web_url: Optional[str] = None)

Response for Create share link

Attributes

web_url class-attribute instance-attribute

web_url: Optional[str] = field(default=None, metadata={'wire_name': 'WebUrl'})

A URL that points to the file or folder.

BlobMetadataPage dataclass

BlobMetadataPage(value: Optional[List[BlobMetadata]] = None, next_link: Optional[str] = None)

Response for List files in folder

Attributes

value class-attribute instance-attribute

value: Optional[List[BlobMetadata]] = None

Blob metadata collection.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

A URL which can be used to retrieve the next page.

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute

table_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = field(default=None, metadata={'wire_name': 'tablePluralName'})

Table plural display name

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Blob dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

OnedriveClient

OnedriveClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for onedrive connector.

Initialize a OnedriveClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

get_file_metadata_async async

get_file_metadata_async(id: str) -> dict[str, Any] | None

Get file metadata

This operation gets the metadata for a file.

update_file_async async

update_file_async(input: bytes, id: str) -> dict[str, Any] | None

Update file

This operation updates a file.

delete_file_async async

delete_file_async(id: str) -> None

Delete file

This operation deletes a file.

get_file_metadata_by_path_async async

get_file_metadata_by_path_async(path: str) -> dict[str, Any] | None

Get file metadata using path

This operation gets the metadata of a file using the path.

get_file_content_by_path_async async

get_file_content_by_path_async(path: str, infer_content_type: Optional[bool] = None) -> bytes

Get file content using path

This operation gets the content of a file using the path.

get_file_content_async async

get_file_content_async(id: str, infer_content_type: Optional[bool] = None) -> bytes

Get file content

This operation gets the content of a file.

create_file_async async

create_file_async(input: bytes, folder_path: str, name: str) -> dict[str, Any] | None

Create file

This operation creates a file.

copy_file_async async

copy_file_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Upload file from URL

This operation uploads a file from a URL to OneDrive.

copy_drive_file_async async

copy_drive_file_async(id: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Copy file

This operation copies a file within OneDrive.

copy_drive_file_by_path_async async

copy_drive_file_by_path_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Copy file using path

This operation copies a file within OneDrive by path.

move_file_async async

move_file_async(id: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Move or rename a file

This operation moves or renames a file.

move_file_by_path_async async

move_file_by_path_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Move or rename a file using path

This operation moves or renames a file using the path.

convert_file_async async

convert_file_async(id: str, type_: Optional[str] = None) -> bytes

Convert file

This operation converts a file to another format. The list of supported conversions can be found at https://aka.ms/onedriveconversions

convert_file_by_path_async async

convert_file_by_path_async(path: str, type_: Optional[str] = None) -> bytes

Convert file using path

This operation converts a file to another format using the path. The list of supported conversions can be found at https://aka.ms/onedriveconversions

get_file_tags_async async

get_file_tags_async(id: str) -> dict[str, Any] | None

Get file tags

This operation gets the tags of a file.

add_file_tag_async async

add_file_tag_async(id: str, tag: str) -> dict[str, Any] | None

Add file tag

This operation adds a tag to a file.

remove_file_tag_async async

remove_file_tag_async(id: str, tag: str) -> None

Remove file tag

This operation removes a tag from a file.

get_file_thumbnail_async async

get_file_thumbnail_async(id: str, size: str) -> dict[str, Any] | None

Get file thumbnail

This operation gets the thumbnail of a file. The thumbnail will only be valid for 6 hours.

list_root_folder_async async

list_root_folder_async() -> dict[str, Any] | None

List files in root folder

This operation gets the list of files and subfolders in the root folder.

find_files_async async

find_files_async(id: str, query: str, find_mode: str, max_file_count: Optional[int] = None) -> dict[str, Any] | None

Find files in folder

This operation finds files within a folder using search or name pattern match.

find_files_by_path_async async

find_files_by_path_async(query: str, path: str, find_mode: str, max_file_count: Optional[int] = None) -> dict[str, Any] | None

Find files in folder by path

This operation finds files within a folder by path using search or name pattern match.

create_share_link_async async

create_share_link_async(id: str, type_: str) -> dict[str, Any] | None

Create share link

This operation creates a share link for a file.

create_share_link_by_path_async async

create_share_link_by_path_async(path: str, type_: str) -> dict[str, Any] | None

Create share link by path

This operation creates a share link for a file using the path.

extract_folder_async async

extract_folder_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Extract archive to folder

This operation extracts an archive file into a folder (example: .zip). Maximum archive size is 50 MB and 100 files inside.

list_folder_async async

list_folder_async(id: str) -> dict[str, Any] | None

List files in folder

This operation gets the list of files and subfolders in a folder.