GetFileShareResult

data class GetFileShareResult(val accessTier: String? = null, val accessTierChangeTime: String, val accessTierStatus: String, val azureApiVersion: String, val deleted: Boolean, val deletedTime: String, val enabledProtocols: String? = null, val etag: String, val fileSharePaidBursting: FileSharePropertiesResponseFileSharePaidBursting? = null, val id: String, val includedBurstIops: Int, val lastModifiedTime: String, val leaseDuration: String, val leaseState: String, val leaseStatus: String, val maxBurstCreditsForIops: Double, val metadata: Map<String, String>? = null, val name: String, val nextAllowedProvisionedBandwidthDowngradeTime: String, val nextAllowedProvisionedIopsDowngradeTime: String, val nextAllowedQuotaDowngradeTime: String, val provisionedBandwidthMibps: Int? = null, val provisionedIops: Int? = null, val remainingRetentionDays: Int, val rootSquash: String? = null, val shareQuota: Int? = null, val shareUsageBytes: Double, val signedIdentifiers: List<SignedIdentifierResponse>? = null, val snapshotTime: String, val type: String, val version: String)

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

Constructors

Link copied to clipboard
constructor(accessTier: String? = null, accessTierChangeTime: String, accessTierStatus: String, azureApiVersion: String, deleted: Boolean, deletedTime: String, enabledProtocols: String? = null, etag: String, fileSharePaidBursting: FileSharePropertiesResponseFileSharePaidBursting? = null, id: String, includedBurstIops: Int, lastModifiedTime: String, leaseDuration: String, leaseState: String, leaseStatus: String, maxBurstCreditsForIops: Double, metadata: Map<String, String>? = null, name: String, nextAllowedProvisionedBandwidthDowngradeTime: String, nextAllowedProvisionedIopsDowngradeTime: String, nextAllowedQuotaDowngradeTime: String, provisionedBandwidthMibps: Int? = null, provisionedIops: Int? = null, remainingRetentionDays: Int, rootSquash: String? = null, shareQuota: Int? = null, shareUsageBytes: Double, signedIdentifiers: List<SignedIdentifierResponse>? = null, snapshotTime: String, type: String, version: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val accessTier: String? = null

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

Link copied to clipboard

Indicates the last modification time for share access tier.

Link copied to clipboard

Indicates if there is a pending transition for access tier.

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard

Indicates whether the share was deleted.

Link copied to clipboard

The deleted time if the share was deleted.

Link copied to clipboard

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

Link copied to clipboard

Resource Etag.

Link copied to clipboard

File Share Paid Bursting properties.

Link copied to clipboard
val id: String

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

Link copied to clipboard

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

Link copied to clipboard

Returns the date and time the share was last modified.

Link copied to clipboard

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

Link copied to clipboard

Lease state of the share.

Link copied to clipboard

The lease status of the share.

Link copied to clipboard

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

Link copied to clipboard
val metadata: Map<String, String>? = null

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

Link copied to clipboard

The name of the resource

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val provisionedIops: Int? = null

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.

Link copied to clipboard

Remaining retention days for share that was soft deleted.

Link copied to clipboard
val rootSquash: String? = null

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

Link copied to clipboard
val shareQuota: Int? = null

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.

Link copied to clipboard

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

Link copied to clipboard

List of stored access policies specified on the share.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The version of the share.