Package version:

Interface FileShareItem

The file share properties be listed out.

interface FileShareItem {
    accessTier?: string;
    accessTierChangeTime?: any;
    accessTierStatus?: string;
    deleted?: boolean;
    deletedTime?: any;
    enabledProtocols?: string;
    etag?: string;
    fileSharePaidBursting?: FileSharePropertiesFileSharePaidBursting;
    id?: string;
    includedBurstIops?: number;
    lastModifiedTime?: any;
    leaseDuration?: string;
    leaseState?: string;
    leaseStatus?: string;
    maxBurstCreditsForIops?: number;
    metadata?: {
        [propertyName: string]: string;
    };
    name?: string;
    nextAllowedProvisionedBandwidthDowngradeTime?: any;
    nextAllowedProvisionedIopsDowngradeTime?: any;
    nextAllowedQuotaDowngradeTime?: any;
    provisionedBandwidthMibps?: number;
    provisionedIops?: number;
    remainingRetentionDays?: number;
    rootSquash?: string;
    shareQuota?: number;
    shareUsageBytes?: number;
    signedIdentifiers?: SignedIdentifier[];
    snapshotTime?: any;
    type?: string;
    version?: string;
}

Hierarchy (view full)

Properties

accessTier? accessTierChangeTime? accessTierStatus? deleted? deletedTime? enabledProtocols? etag? fileSharePaidBursting? id? includedBurstIops? lastModifiedTime? leaseDuration? leaseState? leaseStatus? maxBurstCreditsForIops? metadata? name? nextAllowedProvisionedBandwidthDowngradeTime? nextAllowedProvisionedIopsDowngradeTime? nextAllowedQuotaDowngradeTime? provisionedBandwidthMibps? provisionedIops? remainingRetentionDays? rootSquash? shareQuota? shareUsageBytes? signedIdentifiers? snapshotTime? type? version?

Properties

OptionalaccessTier

accessTier?: string

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.

Optional ReadonlyaccessTierChangeTime

accessTierChangeTime?: any

Indicates the last modification time for share access tier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyaccessTierStatus

accessTierStatus?: string

Indicates if there is a pending transition for access tier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlydeleted

deleted?: boolean

Indicates whether the share was deleted. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlydeletedTime

deletedTime?: any

The deleted time if the share was deleted. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalenabledProtocols

enabledProtocols?: string

The authentication protocol that is used for the file share. Can only be specified when creating a share.

Optional Readonlyetag

etag?: string

Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalfileSharePaidBursting

fileSharePaidBursting?: FileSharePropertiesFileSharePaidBursting

File Share Paid Bursting properties.

Optional Readonlyid

id?: string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyincludedBurstIops

includedBurstIops?: number

The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlylastModifiedTime

lastModifiedTime?: any

Returns the date and time the share was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyleaseDuration

leaseDuration?: string

Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyleaseState

leaseState?: string

Lease state of the share. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyleaseStatus

leaseStatus?: string

The lease status of the share. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlymaxBurstCreditsForIops

maxBurstCreditsForIops?: number

The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalmetadata

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

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

Optional Readonlyname

name?: string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlynextAllowedProvisionedBandwidthDowngradeTime

nextAllowedProvisionedBandwidthDowngradeTime?: any

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. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlynextAllowedProvisionedIopsDowngradeTime

nextAllowedProvisionedIopsDowngradeTime?: any

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. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlynextAllowedQuotaDowngradeTime

nextAllowedQuotaDowngradeTime?: any

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 NOTE: This property will not be serialized. It can only be populated by the server.

OptionalprovisionedBandwidthMibps

provisionedBandwidthMibps?: number

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.

OptionalprovisionedIops

provisionedIops?: number

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.

Optional ReadonlyremainingRetentionDays

remainingRetentionDays?: number

Remaining retention days for share that was soft deleted. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalrootSquash

rootSquash?: string

The property is for NFS share only. The default is NoRootSquash.

OptionalshareQuota

shareQuota?: number

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.

Optional ReadonlyshareUsageBytes

shareUsageBytes?: number

The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalsignedIdentifiers

signedIdentifiers?: SignedIdentifier[]

List of stored access policies specified on the share.

Optional ReadonlysnapshotTime

snapshotTime?: any

Creation time of share snapshot returned in the response of list shares with expand param "snapshots". NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlytype

type?: string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlyversion

version?: string

The version of the share. NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility