ShareProperties Class

  • Reference

Share's properties class.

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

Constructor

ShareProperties(**kwargs)

Variables

Name Description
name
str

The name of the share.
last_modified
datetime

A datetime object representing the last time the share was modified.
etag
str

The ETag contains a value that you can use to perform operations conditionally.
quota
int

The allocated quota.
access_tier
str

The share's access tier.
metadata
dict

A dict with name_value pairs to associate with the share as metadata.
snapshot
str

Snapshot of the share.
deleted
datetime

To indicate if this share is deleted or not. This is a service returned value, and the value will be set when list shared including deleted ones.
deleted

To indicate the deleted time of the deleted share. This is a service returned value, and the value will be set when list shared including deleted ones.
version
str

To indicate the version of deleted share. This is a service returned value, and the value will be set when list shared including deleted ones.
remaining_retention_days
int

To indicate how many remaining days the deleted share will be kept. This is a service returned value, and the value will be set when list shared including deleted ones.
provisioned_bandwidth
int

Provisioned bandwidth in megabits/second. Only applicable to premium file accounts.
root_squash
<xref:azure.storage.fileshare.models.ShareRootSquash> or str

Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'.
protocols
list(str)

Indicates the protocols enabled on the share. The protocol can be either SMB or NFS.
enable_snapshot_virtual_directory_access
bool

Specifies whether the snapshot virtual directory should be accessible at the root of the share mount point when NFS is enabled. If not specified, it will be accessible.
paid_bursting_enabled
bool

This property enables paid bursting.
paid_bursting_bandwidth_mibps
int

The maximum throughput the file share can support in MiB/s.
paid_bursting_iops
int

The maximum IOPS the file share can support.

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()