ShareGetPropertiesHeaders interface

Package:

@azure/storage-file-share

Defines headers for Share_getProperties operation.

Properties

accessTier	Returns the access tier set on the share.
accessTierChangeTime	Returns the last modified time (in UTC) of the access tier of the share.
accessTierTransitionState	Returns the transition state between access tiers, when present.
date	A UTC date/time value generated by the service that indicates the time at which the response was initiated.
enabledProtocols	The protocols that have been enabled on the share.
errorCode	Error Code
etag	The ETag contains a value that you can use to perform operations conditionally, in quotes.
lastModified	Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share.
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.
metadata	A set of name-value pairs that contain the user-defined metadata of the share.
nextAllowedQuotaDowngradeTime	Returns the current share next allowed quota downgrade time.
provisionedBandwidthMibps	Returns the current share provisioned bandwidth in megabits per second.
provisionedEgressMBps	Returns the current share provisioned egress in megabytes per second.
provisionedIngressMBps	Returns the current share provisioned ingress in megabytes per second.
provisionedIops	Returns the current share provisioned ipos.
quota	Returns the current share quota in GB.
requestId	This header uniquely identifies the request that was made and can be used for troubleshooting the request.
rootSquash	Valid for NFS shares only.
version	Indicates the version of the File service used to execute the request.

Property Details

accessTier

Returns the access tier set on the share.

accessTier?: string

Property Value

string

accessTierChangeTime

Returns the last modified time (in UTC) of the access tier of the share.

accessTierChangeTime?: Date

Property Value

Date

accessTierTransitionState

Returns the transition state between access tiers, when present.

accessTierTransitionState?: string

Property Value

string

date

A UTC date/time value generated by the service that indicates the time at which the response was initiated.

date?: Date

Property Value

Date

enabledProtocols

The protocols that have been enabled on the share.

enabledProtocols?: string

Property Value

string

errorCode

Error Code

errorCode?: string

Property Value

string

etag

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

etag?: string

Property Value

string

lastModified

Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share.

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

metadata

A set of name-value pairs that contain the user-defined metadata of the share.

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

nextAllowedQuotaDowngradeTime

Returns the current share next allowed quota downgrade time.

nextAllowedQuotaDowngradeTime?: Date

Property Value

Date

provisionedBandwidthMibps

Returns the current share provisioned bandwidth in megabits per second.

provisionedBandwidthMibps?: number

Property Value

number

provisionedEgressMBps

Returns the current share provisioned egress in megabytes per second.

provisionedEgressMBps?: number

Property Value

number

provisionedIngressMBps

Returns the current share provisioned ingress in megabytes per second.

provisionedIngressMBps?: number

Property Value

number

provisionedIops

Returns the current share provisioned ipos.

provisionedIops?: number

Property Value

number

quota

Returns the current share quota in GB.

quota?: number

Property Value

number

requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

requestId?: string

Property Value

string

rootSquash

Valid for NFS shares only.

rootSquash?: ShareRootSquash

Property Value

ShareRootSquash

version

Indicates the version of the File service used to execute the request.

version?: string

Property Value

string