IFileShareProperties Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.FileSharePropertiesTypeConverter))]
public interface IFileShareProperties : Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IJsonSerializable[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.FileSharePropertiesTypeConverter))>]
type IFileShareProperties = interface
interface IJsonSerializablePublic Interface IFileShareProperties
Implements IJsonSerializable- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| 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. |
| EnabledProtocol |
The authentication protocol that is used for the file share. Can only be specified when creating a share. |
| FileSharePaidBurstingEnabled |
Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. |
| FileSharePaidBurstingMaxBandwidthMibp |
The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. |
| FileSharePaidBurstingMaxIop |
The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. |
| IncludedBurstIop |
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. |
| MaxBurstCreditsForIop |
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 |
| ProvisionedBandwidthMibp |
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. |
| ProvisionedIop |
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. |
| RemainingRetentionDay |
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. |
| ShareUsageByte |
The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. |
| SignedIdentifier |
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. |
Methods
| Name | Description |
|---|---|
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |