Skip to content

AzureblobClient

Attributes

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnUpdatedFiles_V2': {'operation_id': 'OnUpdatedFiles_V2', 'path': '/{connectionId}/v2/datasets/{dataset}/triggers/batch/onupdatedfile', 'method': 'get', 'required_parameters': ['dataset', 'folderId'], 'callback_payload_type': 'BlobMetadata'}}

Classes

BlobMetadata dataclass 

BlobMetadata(id: Optional[str] = None, name: 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)

Response for Copy blob

Attributes

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

The unique id 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.

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 size of the file or folder.

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 filelocator of the file or folder.

SharedAccessSignature dataclass 

SharedAccessSignature(web_url: Optional[str] = None)

Response for Create SAS URI by path

Attributes

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

A URL to an object with access token.

SharedAccessSignatureBlobPolicy dataclass 

SharedAccessSignatureBlobPolicy(group_policy_identifier: Optional[str] = None, permissions: Optional[str] = None, start_time: Optional[str] = None, expiry_time: Optional[str] = None, access_protocol: Optional[str] = None, ip_address_or_range: Optional[str] = None)

Response for Get available access policies

Attributes

group_policy_identifier class-attribute instance-attribute 
group_policy_identifier: Optional[str] = field(default=None, metadata={'wire_name': 'GroupPolicyIdentifier'})

The string identifying a stored access policy. The Group policy parameters (e.g. Start time and End time) have precedence over input parameters mentioned in actions.

permissions class-attribute instance-attribute 
permissions: Optional[str] = field(default=None, metadata={'wire_name': 'Permissions'})

The permissions specified on the SAS (Values separated by comma).

start_time class-attribute instance-attribute 
start_time: Optional[str] = field(default=None, metadata={'wire_name': 'StartTime'})

The date and time at which the SAS becomes valid (example: '2017-11-01T15:30:00+00:00'). Default = now().

expiry_time class-attribute instance-attribute 
expiry_time: Optional[str] = field(default=None, metadata={'wire_name': 'ExpiryTime'})

The date and time after which the SAS is no longer valid (example: '2017-12-01T15:30:00+00:00'). Default = now() + 24h.

access_protocol class-attribute instance-attribute 
access_protocol: Optional[str] = field(default=None, metadata={'wire_name': 'AccessProtocol'})

The allowed protocols (https only, or http and https). Null if you don't want to restrict protocol.

ip_address_or_range class-attribute instance-attribute 
ip_address_or_range: Optional[str] = field(default=None, metadata={'wire_name': 'IpAddressOrRange'})

The allowed IP address or IP address range. Null if you don't want to restrict based on IP address.

DataWithSensitivityLabelInfo dataclass 

DataWithSensitivityLabelInfo(id: Optional[str] = None, name: 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, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Response for Get Blob Metadata

Attributes

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

The unique id 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.

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 size of the file or folder.

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 filelocator of the file or folder.

sensitivity_label_info class-attribute instance-attribute 
sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field(default=None, metadata={'wire_name': 'SensitivityLabelInfo'})

Sensitivity label metadata info list

ListOfBlobsWithSensitivityLabels dataclass 

ListOfBlobsWithSensitivityLabels(value: Optional[List[DataWithSensitivityLabelInfo]] = None)

Response for Lists blobs

Attributes

value class-attribute instance-attribute 
value: Optional[List[DataWithSensitivityLabelInfo]] = None

List of Blobs

BlobMetadataPage dataclass 

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

Response for Lists blobs in the root folder

Attributes

value class-attribute instance-attribute 
value: Optional[List[BlobMetadata]] = None

Blob metadata collection.

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

An Url which can be used to retrieve the next page.

next_page_marker class-attribute instance-attribute 
next_page_marker: Optional[str] = field(default=None, metadata={'wire_name': 'nextPageMarker'})

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

StorageAccountList dataclass 

StorageAccountList(value: Optional[List[StorageAccount]] = None)

Response for Get storage accounts

Attributes

value class-attribute instance-attribute 
value: Optional[List[StorageAccount]] = None

List of storage account names

ObjectEntity dataclass 

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

BlobMetadataResponse dataclass 

BlobMetadataResponse(id: Optional[str] = None, name: 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)

Definition: BlobMetadataResponse

Attributes

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

The unique id 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.

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 size of the file or folder.

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 filelocator of the file or folder.

SensitivityLabelMetadata dataclass 

SensitivityLabelMetadata(sensitivity_label_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, tooltip: Optional[str] = None, priority: Optional[int] = None, color: Optional[str] = None, is_encrypted: Optional[bool] = None, is_enabled: Optional[bool] = None, is_parent: Optional[bool] = None, parent_sensitivity_label_id: Optional[str] = None)

Definition: SensitivityLabelMetadata

Attributes

sensitivity_label_id class-attribute instance-attribute 
sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute 
name: Optional[str] = None

SensitivityLabel name.

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

SensitivityLabel displayName info

tooltip class-attribute instance-attribute 
tooltip: Optional[str] = None

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute 
priority: Optional[int] = None

SensitivityLabel priority.

color class-attribute instance-attribute 
color: Optional[str] = None

SensitivityLabel color.

is_encrypted class-attribute instance-attribute 
is_encrypted: Optional[bool] = field(default=None, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute 
is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute 
is_parent: Optional[bool] = field(default=None, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute 
parent_sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentSensitivityLabelId'})

Parent SensitivityLabel Id.

StorageAccount dataclass 

StorageAccount(name: Optional[str] = None, display_name: Optional[str] = None)

Definition: StorageAccount

Attributes

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

The name of the storage account.

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

The display name of the storage account.

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

AzureblobClient 

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

Bases: ConnectorClientBase

Typed client for azureblob connector.

Initialize a AzureblobClient.

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:

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

Copy blob

This operation copies a blob. If blob is being deleted/renamed on server right after it was copied, connector may return HTTP 404 error by it's design. Please use a delay for 1 minute before deleting or renaming newly created blob. Chunk transfer is not supported in this action. If source and destination are present in same storage account, please use relative path. Otherwise, maximum size of a source for copy blob operation is 50 MB.

create_block_blob_async async 
create_block_blob_async(input: bytes, storage_account_name: str, folder_path: str, name: str) -> None

Create block blob

This operation uploads a block blob to Azure Blob Storage.

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

Create blob

This operation uploads a blob to Azure Blob Storage.

create_share_link_by_path_async(input: SharedAccessSignatureBlobPolicy, storage_account_name: str, path: str) -> dict[str, Any] | None

Create SAS URI by path

This operation creates a SAS link for a blob using the path.

delete_file_async async 
delete_file_async(dataset: str, id: str) -> None

Delete blob

This operation deletes a blob.

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

Extract archive to folder

This operation extracts an archive blob into a folder (example: .zip).

get_access_policies_async async 
get_access_policies_async(storage_account_name: str, path: str) -> dict[str, Any] | None

Get available access policies

This operation gets available shared access policies for a blob.

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

Get blob content

This operation retrieves blob contents using id.

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

Get blob content using path

This operation retrieves blob contents using path.

get_file_metadata_async async 
get_file_metadata_async(dataset: str, id: str, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Get Blob Metadata

This operation retrieves blob metadata using blob id.

get_file_metadata_by_path_async async 
get_file_metadata_by_path_async(dataset: str, path: str, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Get Blob Metadata using path

This operation retrieves blob metadata using path.

list_folder_async async 
list_folder_async(dataset: str, id: str, next_page_marker: Optional[str] = None, use_flat_listing: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Lists blobs

This operation lists blobs in a container.

list_root_folder_async async 
list_root_folder_async(dataset: str, next_page_marker: Optional[str] = None) -> dict[str, Any] | None

Lists blobs in the root folder

This operation lists blobs in the Azure Blob Storage root folder.

set_blob_tier_by_path_async async 
set_blob_tier_by_path_async(storage_account_name: str, path: str, new_tier: str) -> None

Set blob tier by path

This operation sets a tier for a block blob on a standard storage account using the path.

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

Update blob

This operation updates a blob in Azure Blob Storage.

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

Get storage accounts

This operation list the user's Azure Storage Account.