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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

name class-attribute instance-attribute

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

The name of the file or folder.

display_name class-attribute instance-attribute

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

The display name of the file or folder.

path class-attribute instance-attribute

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

The path of the file or folder.

last_modified class-attribute instance-attribute

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

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

size class-attribute instance-attribute

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

The size of the file or folder.

media_type class-attribute instance-attribute

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

The media type of the file or folder.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute

file_locator: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Permissions'})

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

start_time class-attribute instance-attribute

start_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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 | Mapping[str, Any]]] = None)

Response for Get Blob Metadata

Attributes

id class-attribute instance-attribute

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

The unique id of the file or folder.

name class-attribute instance-attribute

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

The name of the file or folder.

display_name class-attribute instance-attribute

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

The display name of the file or folder.

path class-attribute instance-attribute

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

The path of the file or folder.

last_modified class-attribute instance-attribute

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

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

size class-attribute instance-attribute

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

The size of the file or folder.

media_type class-attribute instance-attribute

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

The media type of the file or folder.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute

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

The filelocator of the file or folder.

sensitivity_label_info class-attribute instance-attribute

sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SensitivityLabelInfo'})

Sensitivity label metadata info list

ListOfBlobsWithSensitivityLabels dataclass

ListOfBlobsWithSensitivityLabels(*, value: Optional[List[DataWithSensitivityLabelInfo | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Lists blobs

Attributes

value class-attribute instance-attribute

value: Optional[List[DataWithSensitivityLabelInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Blobs

next_link class-attribute instance-attribute

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

The URL to retrieve the next page.

BlobMetadataPage dataclass

BlobMetadataPage(*, value: Optional[List[BlobMetadata | Mapping[str, Any]]] = 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 | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Blob metadata collection.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextPageMarker'})

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

StorageAccountList dataclass

StorageAccountList(*, value: Optional[List[StorageAccount | Mapping[str, Any]]] = None)

Response for Get storage accounts

Attributes

value class-attribute instance-attribute

value: Optional[List[StorageAccount | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

name class-attribute instance-attribute

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

The name of the file or folder.

display_name class-attribute instance-attribute

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

The display name of the file or folder.

path class-attribute instance-attribute

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

The path of the file or folder.

last_modified class-attribute instance-attribute

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

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

size class-attribute instance-attribute

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

The size of the file or folder.

media_type class-attribute instance-attribute

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

The media type of the file or folder.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute

file_locator: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel name.

display_name class-attribute instance-attribute

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

SensitivityLabel displayName info

tooltip class-attribute instance-attribute

tooltip: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute

priority: Optional[int] = dataclass_field(default=None, kw_only=True)

SensitivityLabel priority.

color class-attribute instance-attribute

color: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel color.

is_encrypted class-attribute instance-attribute

is_encrypted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute

is_parent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute

parent_sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the storage account.

display_name class-attribute instance-attribute

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

The display name of the storage account.

DataSetsMetadata dataclass

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = 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] = dataclass_field(default=None, kw_only=True)

Dataset source

display_name class-attribute instance-attribute

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

Dataset display name

url_encoding class-attribute instance-attribute

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

Dataset url encoding

table_display_name class-attribute instance-attribute

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

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Blob dataset source

display_name class-attribute instance-attribute

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

Blob dataset display name

url_encoding class-attribute instance-attribute

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

Blob dataset url encoding

AzureblobClient

AzureblobClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

copy_file async

copy_file(dataset: str, source: str, destination: str, *, overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.

Swagger operation ID: CopyFile_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
source	str	Specify the url to source blob.	required
destination	str	Specify the destination blob path, including the target blob name.	required
overwrite	Optional[bool]	Should the destination blob be overwritten (true/false)?.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_block_blob async

create_block_blob(input: bytes, storage_account_name: str, folder_path: str, name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Create block blob

This operation uploads a block blob to Azure Blob Storage.

Swagger operation ID: CreateBlockBlob_V2.

Parameters:

Name	Type	Description	Default
input	bytes	The binary request body.	required
storage_account_name	str	The storage account name.	required
folder_path	str	Specify folder path to upload.	required
name	str	Specify name of the blob to create.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_file async

create_file(input: bytes, dataset: str, folder_path: str, name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create blob

This operation uploads a blob to Azure Blob Storage.

Swagger operation ID: CreateFile_V2.

Parameters:

Name	Type	Description	Default
input	bytes	The binary request body.	required
dataset	str	Azure Storage account name or blob endpoint.	required
folder_path	str	Specify folder path to upload.	required
name	str	Specify name of the blob to create.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_share_link_by_path async

create_share_link_by_path(input: SharedAccessSignatureBlobPolicy | Mapping[str, Any], storage_account_name: str, path: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create SAS URI by path

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

Swagger operation ID: CreateShareLinkByPath_V2.

Parameters:

Name	Type	Description	Default
input	SharedAccessSignatureBlobPolicy | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
storage_account_name	str	Azure Storage account name or blob endpoint.	required
path	str	The unique path of the blob.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_file async

delete_file(dataset: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete blob

This operation deletes a blob.

Swagger operation ID: DeleteFile_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
id	str	Specify the blob to delete.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

extract_folder async

extract_folder(dataset: str, source: str, destination: str, *, overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Extract archive to folder

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

Swagger operation ID: ExtractFolder_V3.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
source	str	Specify the path to the archive blob.	required
destination	str	Specify the path in Azure Blob Storage to extract the archive contents.	required
overwrite	Optional[bool]	Should destination blob be overwritten (true/false)?.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_access_policies

list_access_policies(storage_account_name: str, path: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get available access policies

This operation gets available shared access policies for a blob.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAccessPolicies_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or blob endpoint.	required
path	str	The unique path of the blob.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_file_content async

get_file_content(dataset: str, id: str, *, infer_content_type: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get blob content

This operation retrieves blob contents using id.

Swagger operation ID: GetFileContent_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
id	str	Specify the blob.	required
infer_content_type	Optional[bool]	Infer content-type based on extension.	None
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_file_content_by_path async

get_file_content_by_path(dataset: str, path: str, *, infer_content_type: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get blob content using path

This operation retrieves blob contents using path.

Swagger operation ID: GetFileContentByPath_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
path	str	Specify unique path to the blob.	required
infer_content_type	Optional[bool]	Infer content-type based on extension.	None
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_file_metadata async

get_file_metadata(dataset: str, id: str, *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Blob Metadata

This operation retrieves blob metadata using blob id.

Swagger operation ID: GetFileMetadata_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
id	str	Specify the blob.	required
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_file_metadata_by_path async

get_file_metadata_by_path(dataset: str, path: str, *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Blob Metadata using path

This operation retrieves blob metadata using path.

Swagger operation ID: GetFileMetadataByPath_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
path	str	Specify unique path to the blob.	required
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_folder

list_folder(dataset: str, id: str, *, use_flat_listing: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Lists blobs

This operation lists blobs in a container.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListFolder_V4.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
id	str	Specify the folder.	required
use_flat_listing	Optional[bool]	Whether or not to list blobs in flat listing".	None
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_root_folder

list_root_folder(dataset: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Lists blobs in the root folder

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

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListRootFolder_V4.

Parameters:

Name	Type	Description	Default
dataset	str	Azure Storage account name or blob endpoint.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

set_blob_tier_by_path async

set_blob_tier_by_path(storage_account_name: str, path: str, new_tier: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Set blob tier by path

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

Swagger operation ID: SetBlobTierByPath_V2.

Parameters:

Name	Type	Description	Default
storage_account_name	str	Azure Storage account name or blob endpoint.	required
path	str	The unique path of the blob.	required
new_tier	str	The new tier for the blob.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_file async

update_file(input: bytes, dataset: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update blob

This operation updates a blob in Azure Blob Storage.

Swagger operation ID: UpdateFile_V2.

Parameters:

Name	Type	Description	Default
input	bytes	The binary request body.	required
dataset	str	Azure Storage account name or blob endpoint.	required
id	str	Specify the blob to update.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_data_sets

list_data_sets(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get storage accounts

This operation list the user's Azure Storage Account.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDataSets.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.