FileShareItem interface
The file share properties be listed out.
- Extends
Properties
access |
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
access |
Indicates the last modification time for share access tier. NOTE: This property will not be serialized. It can only be populated by the server. |
access |
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. |
deleted | Indicates whether the share was deleted. NOTE: This property will not be serialized. It can only be populated by the server. |
deleted |
The deleted time if the share was deleted. NOTE: This property will not be serialized. It can only be populated by the server. |
enabled |
The authentication protocol that is used for the file share. Can only be specified when creating a share. |
last |
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. |
lease |
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. |
lease |
Lease state of the share. NOTE: This property will not be serialized. It can only be populated by the server. |
lease |
The lease status of the share. NOTE: This property will not be serialized. It can only be populated by the server. |
metadata | A name-value pair to associate with the share as metadata. |
remaining |
Remaining retention days for share that was soft deleted. NOTE: This property will not be serialized. It can only be populated by the server. |
root |
The property is for NFS share only. The default is NoRootSquash. |
share |
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. |
share |
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. |
signed |
List of stored access policies specified on the share. |
snapshot |
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. |
version | The version of the share. NOTE: This property will not be serialized. It can only be populated by the server. |
Inherited Properties
etag | Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server. |
id | 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. |
name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
type | 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. |
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. NOTE: This property will not be serialized. It can only be populated by the server.
accessTierChangeTime?: Date
Property Value
Date
accessTierStatus
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.
accessTierStatus?: string
Property Value
string
deleted
Indicates whether the share was deleted. NOTE: This property will not be serialized. It can only be populated by the server.
deleted?: boolean
Property Value
boolean
deletedTime
The deleted time if the share was deleted. NOTE: This property will not be serialized. It can only be populated by the server.
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
lastModifiedTime
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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
leaseDuration?: string
Property Value
string
leaseState
Lease state of the share. NOTE: This property will not be serialized. It can only be populated by the server.
leaseState?: string
Property Value
string
leaseStatus
The lease status of the share. NOTE: This property will not be serialized. It can only be populated by the server.
leaseStatus?: string
Property Value
string
metadata
A name-value pair to associate with the share as metadata.
metadata?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
remainingRetentionDays
Remaining retention days for share that was soft deleted. NOTE: This property will not be serialized. It can only be populated by the server.
remainingRetentionDays?: number
Property Value
number
rootSquash
The property is for NFS share only. The default is NoRootSquash.
rootSquash?: string
Property Value
string
shareQuota
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
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. NOTE: This property will not be serialized. It can only be populated by the server.
shareUsageBytes?: number
Property Value
number
signedIdentifiers
List of stored access policies specified on the share.
signedIdentifiers?: SignedIdentifier[]
Property Value
snapshotTime
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.
snapshotTime?: Date
Property Value
Date
version
The version of the share. NOTE: This property will not be serialized. It can only be populated by the server.
version?: string
Property Value
string
Inherited Property Details
etag
Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server.
etag?: string
Property Value
string
Inherited From AzureEntityResource.etag
id
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.
id?: string
Property Value
string
Inherited From AzureEntityResource.id
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From AzureEntityResource.name
type
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.
type?: string
Property Value
string
Inherited From AzureEntityResource.type