Share via

SharePropertiesInternal interface

  • Reference
Package:
@azure/storage-file-share

Properties of a share.

Properties

accessTier
accessTierChangeTime
accessTierTransitionState
deletedTime
enabledProtocols
enableSnapshotVirtualDirectoryAccess
etag
includedBurstIops
lastModified
leaseDuration

When a share is leased, specifies whether the lease is of infinite or fixed duration.
leaseState

Lease state of the share.
leaseStatus

The current lease status of the share.
maxBurstCreditsForIops
nextAllowedProvisionedBandwidthDowngradeTime
nextAllowedProvisionedIopsDowngradeTime
nextAllowedQuotaDowngradeTime
paidBurstingEnabled
paidBurstingMaxBandwidthMibps
paidBurstingMaxIops
provisionedBandwidthMiBps
provisionedEgressMBps
provisionedIngressMBps
provisionedIops
quota
remainingRetentionDays
rootSquash

Property Details

accessTier 

accessTier?: string

Property Value

string

accessTierChangeTime 

accessTierChangeTime?: Date

Property Value

Date

accessTierTransitionState 

accessTierTransitionState?: string

Property Value

string

deletedTime 

deletedTime?: Date

Property Value

Date

enabledProtocols 

enabledProtocols?: string

Property Value

string

enableSnapshotVirtualDirectoryAccess 

enableSnapshotVirtualDirectoryAccess?: boolean

Property Value

boolean

etag 

etag: string

Property Value

string

includedBurstIops 

includedBurstIops?: number

Property Value

number

lastModified 

lastModified: Date

Property Value

Date

leaseDuration

When a share is leased, specifies whether the lease is of infinite or fixed duration.

leaseDuration?: LeaseDurationType

Property Value

LeaseDurationType

leaseState

Lease state of the share.

leaseState?: LeaseStateType

Property Value

LeaseStateType

leaseStatus

The current lease status of the share.

leaseStatus?: LeaseStatusType

Property Value

LeaseStatusType

maxBurstCreditsForIops 

maxBurstCreditsForIops?: number

Property Value

number

nextAllowedProvisionedBandwidthDowngradeTime 

nextAllowedProvisionedBandwidthDowngradeTime?: Date

Property Value

Date

nextAllowedProvisionedIopsDowngradeTime 

nextAllowedProvisionedIopsDowngradeTime?: Date

Property Value

Date

nextAllowedQuotaDowngradeTime 

nextAllowedQuotaDowngradeTime?: Date

Property Value

Date

paidBurstingEnabled 

paidBurstingEnabled?: boolean

Property Value

boolean

paidBurstingMaxBandwidthMibps 

paidBurstingMaxBandwidthMibps?: number

Property Value

number

paidBurstingMaxIops 

paidBurstingMaxIops?: number

Property Value

number

provisionedBandwidthMiBps 

provisionedBandwidthMiBps?: number

Property Value

number

provisionedEgressMBps 

provisionedEgressMBps?: number

Property Value

number

provisionedIngressMBps 

provisionedIngressMBps?: number

Property Value

number

provisionedIops 

provisionedIops?: number

Property Value

number

quota 

quota: number

Property Value

number

remainingRetentionDays 

remainingRetentionDays?: number

Property Value

number

rootSquash 

rootSquash?: ShareRootSquash

Property Value

ShareRootSquash