ShareGetPropertiesHeaders interface
Defines headers for Share_getProperties operation.
Properties
| access |
Returns the access tier set on the share. |
| access |
Returns the last modified time (in UTC) of the access tier of the share. |
| access |
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. |
| enabled |
The protocols that have been enabled on the share. |
| enable |
Version 2023-08-03 and newer. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. This header is only returned for shares, not for snapshots. |
| error |
Error Code |
| etag | The ETag contains a value that you can use to perform operations conditionally, in quotes. |
| last |
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. |
| lease |
When a share is leased, specifies whether the lease is of infinite or fixed duration. |
| lease |
Lease state of the share. |
| lease |
The current lease status of the share. |
| metadata | A set of name-value pairs that contain the user-defined metadata of the share. |
| next |
Returns the current share next allowed quota downgrade time. |
| paid |
Optional. Boolean. Default if not specified is false. This property enables paid bursting. |
| paid |
Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec. |
| paid |
Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS. |
| provisioned |
Returns the current share provisioned bandwidth in megabits per second. |
| provisioned |
Returns the current share provisioned egress in megabytes per second. |
| provisioned |
Returns the current share provisioned ingress in megabytes per second. |
| provisioned |
Returns the current share provisioned ipos. |
| quota | Returns the current share quota in GB. |
| request |
This header uniquely identifies the request that was made and can be used for troubleshooting the request. |
| root |
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?: stringProperty Value
string
accessTierChangeTime
Returns the last modified time (in UTC) of the access tier of the share.
accessTierChangeTime?: DateProperty Value
Date
accessTierTransitionState
Returns the transition state between access tiers, when present.
accessTierTransitionState?: stringProperty Value
string
date
A UTC date/time value generated by the service that indicates the time at which the response was initiated.
date?: DateProperty Value
Date
enabledProtocols
The protocols that have been enabled on the share.
enabledProtocols?: stringProperty Value
string
enableSnapshotVirtualDirectoryAccess
Version 2023-08-03 and newer. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. This header is only returned for shares, not for snapshots.
enableSnapshotVirtualDirectoryAccess?: booleanProperty Value
boolean
errorCode
Error Code
errorCode?: stringProperty Value
string
etag
The ETag contains a value that you can use to perform operations conditionally, in quotes.
etag?: stringProperty 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?: DateProperty Value
Date
leaseDuration
When a share is leased, specifies whether the lease is of infinite or fixed duration.
leaseDuration?: LeaseDurationTypeProperty Value
leaseState
leaseStatus
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?: DateProperty Value
Date
paidBurstingEnabled
Optional. Boolean. Default if not specified is false. This property enables paid bursting.
paidBurstingEnabled?: booleanProperty Value
boolean
paidBurstingMaxBandwidthMibps
Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.
paidBurstingMaxBandwidthMibps?: numberProperty Value
number
paidBurstingMaxIops
Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.
paidBurstingMaxIops?: numberProperty Value
number
provisionedBandwidthMibps
Returns the current share provisioned bandwidth in megabits per second.
provisionedBandwidthMibps?: numberProperty Value
number
provisionedEgressMBps
Returns the current share provisioned egress in megabytes per second.
provisionedEgressMBps?: numberProperty Value
number
provisionedIngressMBps
Returns the current share provisioned ingress in megabytes per second.
provisionedIngressMBps?: numberProperty Value
number
provisionedIops
Returns the current share provisioned ipos.
provisionedIops?: numberProperty Value
number
quota
Returns the current share quota in GB.
quota?: numberProperty Value
number
requestId
This header uniquely identifies the request that was made and can be used for troubleshooting the request.
requestId?: stringProperty Value
string
rootSquash
version
Indicates the version of the File service used to execute the request.
version?: stringProperty Value
string