Share via

ShareProperties Class

  • Reference

Share's properties class.

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

Constructor

ShareProperties(**kwargs: Any)

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_tier

The share's access tier.'

access_tier: str

deleted

Whether this share was deleted. This is a service returned value, and the value will be set when list shared including deleted ones.

deleted: bool | None = None

deleted_time

A datetime object representing the time at which the share was deleted. This is a service returned value, and the value will be set when list shared including deleted ones.

deleted_time: datetime | None = None

enable_snapshot_virtual_directory_access

Specifies whether the snapshot virtual directory should be accessible at the root of the share mount point when NFS is enabled. if not specified, the default is True.

enable_snapshot_virtual_directory_access: bool | None = None

etag

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

etag: str

last_modified

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

last_modified: datetime

lease

Share lease properties.

lease: LeaseProperties

metadata

Name-value pairs associate with the share as metadata.

metadata: Dict[str, str]

name

The name of the share.

name: str

next_allowed_quota_downgrade_time

The share's next allowed quota downgrade time.

next_allowed_quota_downgrade_time: str | None = None

next_provisioned_bandwidth_downgrade

The share's next allowed provisioned bandwidth downgrade time.

next_provisioned_bandwidth_downgrade: datetime | None

next_provisioned_iops_downgrade

The share's next allowed provisioned throughput downgrade time.

next_provisioned_iops_downgrade: datetime | None

paid_bursting_bandwidth_mibps

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

paid_bursting_bandwidth_mibps: int | None = None

paid_bursting_enabled

This property enables paid bursting.

paid_bursting_enabled: int | None = None

paid_bursting_iops

The maximum IOPS the file share can support.

paid_bursting_iops: int | None = None

protocols

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

protocols: List[str] | None = None

provisioned_bandwidth

Provisioned bandwidth in megabits/second. Only applicable to premium file accounts.

provisioned_bandwidth: int | None = None

provisioned_egress_mbps

Provisioned egress in megabits/second. Only applicable to premium file accounts.

provisioned_egress_mbps: int | None = None

provisioned_ingress_mbps

Provisioned ingress in megabits/second. Only applicable to premium file accounts.

provisioned_ingress_mbps: int | None = None

provisioned_iops

Provisioned input/output operators per second (iops). Only applicable to premium file accounts.

provisioned_iops: int | None = None

quota

The allocated quota.

quota: int

remaining_retention_days

The number of days that the share will be retained before being permanently deleted by the service. This is a service returned value, and the value will be set when list shared including deleted ones.

remaining_retention_days: int | None = None

root_squash

'NoRootSquash', 'RootSquash', 'AllSquash'.

root_squash: ShareRootSquash | str | None = None

snapshot

Snapshot of the share.

snapshot: str | None = None

version

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.

version: str | None = None