Share via

Handle Class

  • Reference

A listed Azure Storage handle item.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.storage.fileshare._shared.models.DictMixin
Handle

Constructor

Handle(**kwargs: Any)

Keyword-Only Parameters

Name Description
client_name
str

Name of the client machine where the share is being mounted.
handle_id
str

XSMB service handle ID.
path
str

File or directory name including full path starting from share root.
file_id
str

FileId uniquely identifies the file or directory.
parent_id
str

ParentId uniquely identifies the parent directory of the object.
session_id
str

SMB session ID in context of which the file handle was opened.
client_ip
str

Client IP that opened the handle.
open_time
datetime

Time when the session that previously opened the handle has last been reconnected. (UTC)
last_reconnect_time
Optional[datetime]

Time handle was last connected to. (UTC)
access_rights
List[Literal['Read', 'Write', 'Delete']]

Access rights of the handle.

Methods

get
has_key
items
keys
update
values

get 

get(key, default=None)

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k)

Parameters

Name Description
k
Required

items 

items()

keys 

keys()

update 

update(*args, **kwargs)

values 

values()

Attributes

access_rights

Access rights of the handle.

access_rights: List[Literal['Read', 'Write', 'Delete']]

client_ip

Client IP that opened the handle.

client_ip: str

client_name

Name of the client machine where the share is being mounted.

client_name: str

file_id

FileId uniquely identifies the file or directory.

file_id: str

id

XSMB service handle ID.

id: str

last_reconnect_time

Time handle that was last connected to. (UTC)

last_reconnect_time: datetime | None

open_time

Time when the session that previously opened the handle was last been reconnected. (UTC)

open_time: datetime

parent_id

ParentId uniquely identifies the parent directory of the object.

parent_id: str

path

File or directory name including full path starting from share root.

path: str

session_id

SMB session ID in context of which the file handle was opened.

session_id: str