Package version:

Interface ShareGetPropertiesHeaders

Defines headers for Share_getProperties operation.

interface ShareGetPropertiesHeaders {
    accessTier?: string;
    accessTierChangeTime?: Date;
    accessTierTransitionState?: string;
    date?: Date;
    enabledProtocols?: string;
    enableSnapshotVirtualDirectoryAccess?: boolean;
    errorCode?: string;
    etag?: string;
    includedBurstIops?: number;
    lastModified?: Date;
    leaseDuration?: LeaseDurationType;
    leaseState?: LeaseStateType;
    leaseStatus?: LeaseStatusType;
    maxBurstCreditsForIops?: number;
    metadata?: {
        [propertyName: string]: string;
    };
    nextAllowedProvisionedBandwidthDowngradeTime?: Date;
    nextAllowedProvisionedIopsDowngradeTime?: Date;
    nextAllowedQuotaDowngradeTime?: Date;
    paidBurstingEnabled?: boolean;
    paidBurstingMaxBandwidthMibps?: number;
    paidBurstingMaxIops?: number;
    provisionedBandwidthMibps?: number;
    provisionedEgressMBps?: number;
    provisionedIngressMBps?: number;
    provisionedIops?: number;
    quota?: number;
    requestId?: string;
    rootSquash?: ShareRootSquash;
    version?: string;
}

Properties

accessTier? accessTierChangeTime? accessTierTransitionState? date? enabledProtocols? enableSnapshotVirtualDirectoryAccess? errorCode? etag? includedBurstIops? lastModified? leaseDuration? leaseState? leaseStatus? maxBurstCreditsForIops? metadata? nextAllowedProvisionedBandwidthDowngradeTime? nextAllowedProvisionedIopsDowngradeTime? nextAllowedQuotaDowngradeTime? paidBurstingEnabled? paidBurstingMaxBandwidthMibps? paidBurstingMaxIops? provisionedBandwidthMibps? provisionedEgressMBps? provisionedIngressMBps? provisionedIops? quota? requestId? rootSquash? version?

Properties

OptionalaccessTier

accessTier?: string

Returns the access tier set on the share.

OptionalaccessTierChangeTime

accessTierChangeTime?: Date

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

OptionalaccessTierTransitionState

accessTierTransitionState?: string

Returns the transition state between access tiers, when present.

Optionaldate

date?: Date

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

OptionalenabledProtocols

enabledProtocols?: string

The protocols that have been enabled on the share.

OptionalenableSnapshotVirtualDirectoryAccess

enableSnapshotVirtualDirectoryAccess?: boolean

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.

OptionalerrorCode

errorCode?: string

Error Code

Optionaletag

etag?: string

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

OptionalincludedBurstIops

includedBurstIops?: number

Return the calculated burst IOPS of the share.

OptionallastModified

lastModified?: Date

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.

OptionalleaseDuration

leaseDuration?: LeaseDurationType

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

OptionalleaseState

leaseState?: LeaseStateType

Lease state of the share.

OptionalleaseStatus

leaseStatus?: LeaseStatusType

The current lease status of the share.

OptionalmaxBurstCreditsForIops

maxBurstCreditsForIops?: number

Returned the calculated maximum burst credits. This is not the current burst credit level, but the maximum burst credits the share can have.

Optionalmetadata

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

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

OptionalnextAllowedProvisionedBandwidthDowngradeTime

nextAllowedProvisionedBandwidthDowngradeTime?: Date

Returns the current share next allowed provisioned bandwidth downgrade time.

OptionalnextAllowedProvisionedIopsDowngradeTime

nextAllowedProvisionedIopsDowngradeTime?: Date

Returns the current share next allowed provisioned iops downgrade time.

OptionalnextAllowedQuotaDowngradeTime

nextAllowedQuotaDowngradeTime?: Date

Returns the current share next allowed quota downgrade time.

OptionalpaidBurstingEnabled

paidBurstingEnabled?: boolean

Optional. Boolean. Default if not specified is false. This property enables paid bursting.

OptionalpaidBurstingMaxBandwidthMibps

paidBurstingMaxBandwidthMibps?: number

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.

OptionalpaidBurstingMaxIops

paidBurstingMaxIops?: number

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.

OptionalprovisionedBandwidthMibps

provisionedBandwidthMibps?: number

Returns the current share provisioned bandwidth in mebibytes per second.

OptionalprovisionedEgressMBps

provisionedEgressMBps?: number

Returns the current share provisioned egress in megabytes per second.

OptionalprovisionedIngressMBps

provisionedIngressMBps?: number

Returns the current share provisioned ingress in megabytes per second.

OptionalprovisionedIops

provisionedIops?: number

Returns the current share provisioned ipos.

Optionalquota

quota?: number

Returns the current share quota in GB.

OptionalrequestId

requestId?: string

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

OptionalrootSquash

rootSquash?: ShareRootSquash

Valid for NFS shares only.

Optionalversion

version?: string

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

Settings

Member Visibility