Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

FileShareInner Class

Package:
com.azure.resourcemanager.storage.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-storage:2.56.0

public final class FileShareInner
extends ProxyResource

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

Constructor Summary

Constructor Description
FileShareInner()

Creates an instance of FileShareInner class.

Method Summary

Modifier and Type Method and Description
ShareAccessTier accessTier()

Get the accessTier property: Access tier for specific share.
OffsetDateTime accessTierChangeTime()

Get the accessTierChangeTime property: Indicates the last modification time for share access tier.
String accessTierStatus()

Get the accessTierStatus property: Indicates if there is a pending transition for access tier.
Boolean deleted()

Get the deleted property: Indicates whether the share was deleted.
OffsetDateTime deletedTime()

Get the deletedTime property: The deleted time if the share was deleted.
EnabledProtocols enabledProtocols()

Get the enabledProtocols property: The authentication protocol that is used for the file share.
String etag()

Get the etag property: Resource Etag.
FileSharePropertiesFileSharePaidBursting fileSharePaidBursting()

Get the fileSharePaidBursting property: File Share Paid Bursting properties.
static FileShareInner fromJson(JsonReader jsonReader)

Reads an instance of FileShareInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
Integer includedBurstIops()

Get the includedBurstIops property: The calculated burst IOPS of the share.
OffsetDateTime lastModifiedTime()

Get the lastModifiedTime property: Returns the date and time the share was last modified.
LeaseDuration leaseDuration()

Get the leaseDuration property: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
LeaseState leaseState()

Get the leaseState property: Lease state of the share.
LeaseStatus leaseStatus()

Get the leaseStatus property: The lease status of the share.
Long maxBurstCreditsForIops()

Get the maxBurstCreditsForIops property: The calculated maximum burst credits for the share.
Map<String,String> metadata()

Get the metadata property: A name-value pair to associate with the share as metadata.
String name()

Get the name property: The name of the resource.
OffsetDateTime nextAllowedProvisionedBandwidthDowngradeTime()

Get the nextAllowedProvisionedBandwidthDowngradeTime property: Returns the next allowed provisioned bandwidth downgrade time for the share.
OffsetDateTime nextAllowedProvisionedIopsDowngradeTime()

Get the nextAllowedProvisionedIopsDowngradeTime property: Returns the next allowed provisioned IOPS downgrade time for the share.
OffsetDateTime nextAllowedQuotaDowngradeTime()

Get the nextAllowedQuotaDowngradeTime property: Returns the next allowed provisioned storage size downgrade time for the share.
Integer provisionedBandwidthMibps()

Get the provisionedBandwidthMibps property: The provisioned bandwidth of the share, in mebibytes per second.
Integer provisionedIops()

Get the provisionedIops property: The provisioned IOPS of the share.
Integer remainingRetentionDays()

Get the remainingRetentionDays property: Remaining retention days for share that was soft deleted.
RootSquashType rootSquash()

Get the rootSquash property: The property is for NFS share only.
Integer shareQuota()

Get the shareQuota property: The provisioned size of the share, in gibibytes.
Long shareUsageBytes()

Get the shareUsageBytes property: The approximate size of the data stored on the share.
List<SignedIdentifier> signedIdentifiers()

Get the signedIdentifiers property: List of stored access policies specified on the share.
OffsetDateTime snapshotTime()

Get the snapshotTime property: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
String version()

Get the version property: The version of the share.
FileShareInner withAccessTier(ShareAccessTier accessTier)

Set the accessTier property: Access tier for specific share.
FileShareInner withEnabledProtocols(EnabledProtocols enabledProtocols)

Set the enabledProtocols property: The authentication protocol that is used for the file share.
FileShareInner withFileSharePaidBursting(FileSharePropertiesFileSharePaidBursting fileSharePaidBursting)

Set the fileSharePaidBursting property: File Share Paid Bursting properties.
FileShareInner withMetadata(Map<String,String> metadata)

Set the metadata property: A name-value pair to associate with the share as metadata.
FileShareInner withProvisionedBandwidthMibps(Integer provisionedBandwidthMibps)

Set the provisionedBandwidthMibps property: The provisioned bandwidth of the share, in mebibytes per second.
FileShareInner withProvisionedIops(Integer provisionedIops)

Set the provisionedIops property: The provisioned IOPS of the share.
FileShareInner withRootSquash(RootSquashType rootSquash)

Set the rootSquash property: The property is for NFS share only.
FileShareInner withShareQuota(Integer shareQuota)

Set the shareQuota property: The provisioned size of the share, in gibibytes.
FileShareInner withSignedIdentifiers(List<SignedIdentifier> signedIdentifiers)

Set the signedIdentifiers property: List of stored access policies specified on the share.

Methods inherited from ProxyResource

Methods inherited from java.lang.Object

Constructor Details

FileShareInner

public FileShareInner()

Creates an instance of FileShareInner class.

Method Details

accessTier

public ShareAccessTier accessTier()

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

Returns:

the accessTier value.

accessTierChangeTime

public OffsetDateTime accessTierChangeTime()

Get the accessTierChangeTime property: Indicates the last modification time for share access tier.

Returns:

the accessTierChangeTime value.

accessTierStatus

public String accessTierStatus()

Get the accessTierStatus property: Indicates if there is a pending transition for access tier.

Returns:

the accessTierStatus value.

deleted

public Boolean deleted()

Get the deleted property: Indicates whether the share was deleted.

Returns:

the deleted value.

deletedTime

public OffsetDateTime deletedTime()

Get the deletedTime property: The deleted time if the share was deleted.

Returns:

the deletedTime value.

enabledProtocols

public EnabledProtocols enabledProtocols()

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

Returns:

the enabledProtocols value.

etag

public String etag()

Get the etag property: Resource Etag.

Returns:

the etag value.

fileSharePaidBursting

public FileSharePropertiesFileSharePaidBursting fileSharePaidBursting()

Get the fileSharePaidBursting property: File Share Paid Bursting properties.

Returns:

the fileSharePaidBursting value.

fromJson

public static FileShareInner fromJson(JsonReader jsonReader)

Reads an instance of FileShareInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FileShareInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

FileShareInner.id()

Returns:

the id value.

includedBurstIops

public Integer includedBurstIops()

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

Returns:

the includedBurstIops value.

lastModifiedTime

public OffsetDateTime lastModifiedTime()

Get the lastModifiedTime property: Returns the date and time the share was last modified.

Returns:

the lastModifiedTime value.

leaseDuration

public LeaseDuration leaseDuration()

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

Returns:

the leaseDuration value.

leaseState

public LeaseState leaseState()

Get the leaseState property: Lease state of the share.

Returns:

the leaseState value.

leaseStatus

public LeaseStatus leaseStatus()

Get the leaseStatus property: The lease status of the share.

Returns:

the leaseStatus value.

maxBurstCreditsForIops

public Long maxBurstCreditsForIops()

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

Returns:

the maxBurstCreditsForIops value.

metadata

public Map<String,String> metadata()

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

Returns:

the metadata value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

FileShareInner.name()

Returns:

the name value.

nextAllowedProvisionedBandwidthDowngradeTime

public OffsetDateTime nextAllowedProvisionedBandwidthDowngradeTime()

Get the nextAllowedProvisionedBandwidthDowngradeTime property: 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.

Returns:

the nextAllowedProvisionedBandwidthDowngradeTime value.

nextAllowedProvisionedIopsDowngradeTime

public OffsetDateTime nextAllowedProvisionedIopsDowngradeTime()

Get the nextAllowedProvisionedIopsDowngradeTime property: 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.

Returns:

the nextAllowedProvisionedIopsDowngradeTime value.

nextAllowedQuotaDowngradeTime

public OffsetDateTime nextAllowedQuotaDowngradeTime()

Get the nextAllowedQuotaDowngradeTime property: 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.

Returns:

the nextAllowedQuotaDowngradeTime value.

provisionedBandwidthMibps

public Integer provisionedBandwidthMibps()

Get the provisionedBandwidthMibps property: 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.

Returns:

the provisionedBandwidthMibps value.

provisionedIops

public Integer provisionedIops()

Get the provisionedIops property: 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.

Returns:

the provisionedIops value.

remainingRetentionDays

public Integer remainingRetentionDays()

Get the remainingRetentionDays property: Remaining retention days for share that was soft deleted.

Returns:

the remainingRetentionDays value.

rootSquash

public RootSquashType rootSquash()

Get the rootSquash property: The property is for NFS share only. The default is NoRootSquash.

Returns:

the rootSquash value.

shareQuota

public Integer shareQuota()

Get the shareQuota property: 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.

Returns:

the shareQuota value.

shareUsageBytes

public Long shareUsageBytes()

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

Returns:

the shareUsageBytes value.

signedIdentifiers

public List<SignedIdentifier> signedIdentifiers()

Get the signedIdentifiers property: List of stored access policies specified on the share.

Returns:

the signedIdentifiers value.

snapshotTime

public OffsetDateTime snapshotTime()

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

Returns:

the snapshotTime value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

FileShareInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

FileShareInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

version

public String version()

Get the version property: The version of the share.

Returns:

the version value.

withAccessTier

public FileShareInner withAccessTier(ShareAccessTier accessTier)

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

Parameters:

accessTier - the accessTier value to set.

Returns:

the FileShareInner object itself.

withEnabledProtocols

public FileShareInner withEnabledProtocols(EnabledProtocols enabledProtocols)

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

Parameters:

enabledProtocols - the enabledProtocols value to set.

Returns:

the FileShareInner object itself.

withFileSharePaidBursting

public FileShareInner withFileSharePaidBursting(FileSharePropertiesFileSharePaidBursting fileSharePaidBursting)

Set the fileSharePaidBursting property: File Share Paid Bursting properties.

Parameters:

fileSharePaidBursting - the fileSharePaidBursting value to set.

Returns:

the FileShareInner object itself.

withMetadata

public FileShareInner withMetadata(Map<String,String> metadata)

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

Parameters:

metadata - the metadata value to set.

Returns:

the FileShareInner object itself.

withProvisionedBandwidthMibps

public FileShareInner withProvisionedBandwidthMibps(Integer provisionedBandwidthMibps)

Set the provisionedBandwidthMibps property: 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.

Parameters:

provisionedBandwidthMibps - the provisionedBandwidthMibps value to set.

Returns:

the FileShareInner object itself.

withProvisionedIops

public FileShareInner withProvisionedIops(Integer provisionedIops)

Set the provisionedIops property: 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.

Parameters:

provisionedIops - the provisionedIops value to set.

Returns:

the FileShareInner object itself.

withRootSquash

public FileShareInner withRootSquash(RootSquashType rootSquash)

Set the rootSquash property: The property is for NFS share only. The default is NoRootSquash.

Parameters:

rootSquash - the rootSquash value to set.

Returns:

the FileShareInner object itself.

withShareQuota

public FileShareInner withShareQuota(Integer shareQuota)

Set the shareQuota property: 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.

Parameters:

shareQuota - the shareQuota value to set.

Returns:

the FileShareInner object itself.

withSignedIdentifiers

public FileShareInner withSignedIdentifiers(List<SignedIdentifier> signedIdentifiers)

Set the signedIdentifiers property: List of stored access policies specified on the share.

Parameters:

signedIdentifiers - the signedIdentifiers value to set.

Returns:

the FileShareInner object itself.

Applies to

Feedback

Was this page helpful?