共用方式為

FileShareItem Class

  • Reference

The file share properties be listed out.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

FileShareItem(*, metadata: Dict[str, str] | None = None, share_quota: int | None = None, provisioned_iops: int | None = None, provisioned_bandwidth_mibps: int | None = None, enabled_protocols: str | _models.EnabledProtocols | None = None, root_squash: str | _models.RootSquashType | None = None, access_tier: str | _models.ShareAccessTier | None = None, signed_identifiers: List[_models.SignedIdentifier] | None = None, file_share_paid_bursting: _models.FileSharePropertiesFileSharePaidBursting | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
metadata
dict[str, str]

A name-value pair to associate with the share as metadata.
share_quota
int

The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.
provisioned_iops
int

The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.
provisioned_bandwidth_mibps
int

The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.
enabled_protocols
str or EnabledProtocols

The authentication protocol that is used for the file share. Can only be specified when creating a share. Known values are: "SMB" and "NFS".
root_squash
str or RootSquashType

The property is for NFS share only. The default is NoRootSquash. Known values are: "NoRootSquash", "RootSquash", and "AllSquash".
access_tier
str or ShareAccessTier

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Known values are: "TransactionOptimized", "Hot", "Cool", and "Premium".
signed_identifiers
list[SignedIdentifier]

List of stored access policies specified on the share.
file_share_paid_bursting
FileSharePropertiesFileSharePaidBursting

File Share Paid Bursting properties.

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
etag
str

Resource Etag.
last_modified_time
datetime

Returns the date and time the share was last modified.
metadata
dict[str, str]

A name-value pair to associate with the share as metadata.
share_quota
int

The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.
provisioned_iops
int

The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.
provisioned_bandwidth_mibps
int

The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.
included_burst_iops
int

The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
max_burst_credits_for_iops
int

The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
next_allowed_quota_downgrade_time
datetime

Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type.
next_allowed_provisioned_iops_downgrade_time
datetime

Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.
next_allowed_provisioned_bandwidth_downgrade_time
datetime

Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.
enabled_protocols
str or EnabledProtocols

The authentication protocol that is used for the file share. Can only be specified when creating a share. Known values are: "SMB" and "NFS".
root_squash
str or RootSquashType

The property is for NFS share only. The default is NoRootSquash. Known values are: "NoRootSquash", "RootSquash", and "AllSquash".
version
str

The version of the share.
deleted
bool

Indicates whether the share was deleted.
deleted_time
datetime

The deleted time if the share was deleted.
remaining_retention_days
int

Remaining retention days for share that was soft deleted.
access_tier
str or ShareAccessTier

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Known values are: "TransactionOptimized", "Hot", "Cool", and "Premium".
access_tier_change_time
datetime

Indicates the last modification time for share access tier.
access_tier_status
str

Indicates if there is a pending transition for access tier.
share_usage_bytes
int

The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
lease_status
str or LeaseStatus

The lease status of the share. Known values are: "Locked" and "Unlocked".
lease_state
str or LeaseState

Lease state of the share. Known values are: "Available", "Leased", "Expired", "Breaking", and "Broken".
lease_duration
str or LeaseDuration

Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. Known values are: "Infinite" and "Fixed".
signed_identifiers
list[SignedIdentifier]

List of stored access policies specified on the share.
snapshot_time
datetime

Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
file_share_paid_bursting
FileSharePropertiesFileSharePaidBursting

File Share Paid Bursting properties.