Share via

Share Class

  • Reference

File share class.

Inheritance
builtins.object
Share

Constructor

Share(name=None, props=None, metadata=None, snapshot=None)

Parameters

Name Description
name
Default value: None
props
Default value: None
metadata
Default value: None
snapshot
Default value: None

Variables

Name Description
name
str

The name of the share.
properties
ShareProperties

System properties for the share.
metadata
dict(str, str)

A dict containing name-value pairs associated with the share as metadata. This var is set to None unless the include=metadata param was included for the list shares operation. If this parameter was specified but the share has no metadata, metadata will be set to an empty dictionary.
snapshot
str

A DateTime value that uniquely identifies the snapshot. The value of this header indicates the snapshot version, and may be used in subsequent requests to access the snapshot.