FileShare interface

Package:
@azure/arm-storage

Properties of the file share, including Id, resource name, resource type, Etag.

Extends
ProxyResource

Properties

accessTier

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

Indicates the last modification time for share access tier.
accessTierStatus

Indicates if there is a pending transition for access tier.
deleted

Indicates whether the share was deleted.
deletedTime

The deleted time if the share was deleted.
enabledProtocols

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

Resource Etag.
fileSharePaidBursting

File Share Paid Bursting properties.
includedBurstIops

The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
lastModifiedTime

Returns the date and time the share was last modified.
leaseDuration

Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
leaseState

Lease state of the share.
leaseStatus

The lease status of the share.
maxBurstCreditsForIops

The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
metadata

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

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.
nextAllowedProvisionedIopsDowngradeTime

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.
nextAllowedQuotaDowngradeTime

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
provisionedBandwidthMibps

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.
provisionedIops

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.
remainingRetentionDays

Remaining retention days for share that was soft deleted.
rootSquash

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

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.
shareUsageBytes

The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
signedIdentifiers

List of stored access policies specified on the share.
snapshotTime

Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
version

The version of the share.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

accessTier

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

accessTier?: string

Property Value

string

accessTierChangeTime

Indicates the last modification time for share access tier.

accessTierChangeTime?: Date

Property Value

Date

accessTierStatus

Indicates if there is a pending transition for access tier.

accessTierStatus?: string

Property Value

string

deleted

Indicates whether the share was deleted.

deleted?: boolean

Property Value

boolean

deletedTime

The deleted time if the share was deleted.

deletedTime?: Date

Property Value

Date

enabledProtocols

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

enabledProtocols?: string

Property Value

string

etag

Resource Etag.

etag?: string

Property Value

string

fileSharePaidBursting

File Share Paid Bursting properties.

fileSharePaidBursting?: FileSharePropertiesFileSharePaidBursting

Property Value

FileSharePropertiesFileSharePaidBursting

includedBurstIops

The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.

includedBurstIops?: number

Property Value

number

lastModifiedTime

Returns the date and time the share was last modified.

lastModifiedTime?: Date

Property Value

Date

leaseDuration

Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.

leaseDuration?: string

Property Value

string

leaseState

Lease state of the share.

leaseState?: string

Property Value

string

leaseStatus

The lease status of the share.

leaseStatus?: string

Property Value

string

maxBurstCreditsForIops

The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.

maxBurstCreditsForIops?: number

Property Value

number

metadata

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

metadata?: Record<string, string>

Property Value

Record<string, string>

nextAllowedProvisionedBandwidthDowngradeTime

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.

nextAllowedProvisionedBandwidthDowngradeTime?: Date

Property Value

Date

nextAllowedProvisionedIopsDowngradeTime

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.

nextAllowedProvisionedIopsDowngradeTime?: Date

Property Value

Date

nextAllowedQuotaDowngradeTime

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

nextAllowedQuotaDowngradeTime?: Date

Property Value

Date

provisionedBandwidthMibps

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.

provisionedBandwidthMibps?: number

Property Value

number

provisionedIops

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.

provisionedIops?: number

Property Value

number

remainingRetentionDays

Remaining retention days for share that was soft deleted.

remainingRetentionDays?: number

Property Value

number

rootSquash

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

rootSquash?: string

Property Value

string

shareQuota

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.

shareQuota?: number

Property Value

number

shareUsageBytes

The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.

shareUsageBytes?: number

Property Value

number

signedIdentifiers

List of stored access policies specified on the share.

signedIdentifiers?: SignedIdentifier[]

Property Value

SignedIdentifier[]

snapshotTime

Creation time of share snapshot returned in the response of list shares with expand param "snapshots".

snapshotTime?: Date

Property Value

Date

version

The version of the share.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type