665 строки
51 KiB
YAML
665 строки
51 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.share.models.ShareProperties"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties"
|
|
name: "ShareProperties"
|
|
nameWithType: "ShareProperties"
|
|
summary: "Properties of a share."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ShareProperties**</br> implements <xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.ShareProperties()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.ShareProperties()"
|
|
name: "ShareProperties()"
|
|
nameWithType: "ShareProperties.ShareProperties()"
|
|
syntax: "public ShareProperties()"
|
|
methods:
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.fromXml(com.azure.xml.XmlReader)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.fromXml(XmlReader xmlReader)"
|
|
name: "fromXml(XmlReader xmlReader)"
|
|
nameWithType: "ShareProperties.fromXml(XmlReader xmlReader)"
|
|
summary: "Reads an instance of Share<wbr>Properties from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static ShareProperties fromXml(XmlReader xmlReader)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of ShareProperties from the XmlReader."
|
|
returns:
|
|
description: "An instance of ShareProperties if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.fromXml(com.azure.xml.XmlReader,java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
name: "fromXml(XmlReader xmlReader, String rootElementName)"
|
|
nameWithType: "ShareProperties.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
summary: "Reads an instance of Share<wbr>Properties from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Optional root element name to override the default defined by the model. Used to support\n cases where the model can deserialize from different root element names."
|
|
name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static ShareProperties fromXml(XmlReader xmlReader, String rootElementName)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of ShareProperties from the XmlReader."
|
|
returns:
|
|
description: "An instance of ShareProperties if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getAccessTier()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getAccessTier()"
|
|
name: "getAccessTier()"
|
|
nameWithType: "ShareProperties.getAccessTier()"
|
|
summary: "Get the access<wbr>Tier property: The access<wbr>Tier property."
|
|
syntax: "public String getAccessTier()"
|
|
desc: "Get the accessTier property: The accessTier property."
|
|
returns:
|
|
description: "the accessTier value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getAccessTierChangeTime()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getAccessTierChangeTime()"
|
|
name: "getAccessTierChangeTime()"
|
|
nameWithType: "ShareProperties.getAccessTierChangeTime()"
|
|
summary: "Get the access<wbr>Tier<wbr>Change<wbr>Time property: The access<wbr>Tier<wbr>Change<wbr>Time property."
|
|
syntax: "public OffsetDateTime getAccessTierChangeTime()"
|
|
desc: "Get the accessTierChangeTime property: The accessTierChangeTime property."
|
|
returns:
|
|
description: "the accessTierChangeTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getAccessTierTransitionState()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getAccessTierTransitionState()"
|
|
name: "getAccessTierTransitionState()"
|
|
nameWithType: "ShareProperties.getAccessTierTransitionState()"
|
|
summary: "Get the access<wbr>Tier<wbr>Transition<wbr>State property: The access<wbr>Tier<wbr>Transition<wbr>State property."
|
|
syntax: "public String getAccessTierTransitionState()"
|
|
desc: "Get the accessTierTransitionState property: The accessTierTransitionState property."
|
|
returns:
|
|
description: "the accessTierTransitionState value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getDeletedTime()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getDeletedTime()"
|
|
name: "getDeletedTime()"
|
|
nameWithType: "ShareProperties.getDeletedTime()"
|
|
summary: "Get the deleted<wbr>Time property: The deleted<wbr>Time property."
|
|
syntax: "public OffsetDateTime getDeletedTime()"
|
|
desc: "Get the deletedTime property: The deletedTime property."
|
|
returns:
|
|
description: "the deletedTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getETag()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getETag()"
|
|
name: "getETag()"
|
|
nameWithType: "ShareProperties.getETag()"
|
|
summary: "Get the e<wbr>Tag property: The e<wbr>Tag property."
|
|
syntax: "public String getETag()"
|
|
desc: "Get the eTag property: The eTag property."
|
|
returns:
|
|
description: "the eTag value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getLastModified()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getLastModified()"
|
|
name: "getLastModified()"
|
|
nameWithType: "ShareProperties.getLastModified()"
|
|
summary: "Get the last<wbr>Modified property: The last<wbr>Modified property."
|
|
syntax: "public OffsetDateTime getLastModified()"
|
|
desc: "Get the lastModified property: The lastModified property."
|
|
returns:
|
|
description: "the lastModified value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getLeaseDuration()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getLeaseDuration()"
|
|
name: "getLeaseDuration()"
|
|
nameWithType: "ShareProperties.getLeaseDuration()"
|
|
summary: "Get the lease<wbr>Duration property: Possible values include: 'infinite', 'fixed'."
|
|
syntax: "public LeaseDurationType getLeaseDuration()"
|
|
desc: "Get the leaseDuration property: Possible values include: 'infinite', 'fixed'."
|
|
returns:
|
|
description: "the leaseDuration value."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.LeaseDurationType?alt=com.azure.storage.file.share.models.LeaseDurationType&text=LeaseDurationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getLeaseState()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getLeaseState()"
|
|
name: "getLeaseState()"
|
|
nameWithType: "ShareProperties.getLeaseState()"
|
|
summary: "Get the lease<wbr>State property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
|
|
syntax: "public LeaseStateType getLeaseState()"
|
|
desc: "Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
|
|
returns:
|
|
description: "the leaseState value."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.LeaseStateType?alt=com.azure.storage.file.share.models.LeaseStateType&text=LeaseStateType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getLeaseStatus()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getLeaseStatus()"
|
|
name: "getLeaseStatus()"
|
|
nameWithType: "ShareProperties.getLeaseStatus()"
|
|
summary: "Get the lease<wbr>Status property: Possible values include: 'locked', 'unlocked'."
|
|
syntax: "public LeaseStatusType getLeaseStatus()"
|
|
desc: "Get the leaseStatus property: Possible values include: 'locked', 'unlocked'."
|
|
returns:
|
|
description: "the leaseStatus value."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.LeaseStatusType?alt=com.azure.storage.file.share.models.LeaseStatusType&text=LeaseStatusType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getMetadata()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getMetadata()"
|
|
name: "getMetadata()"
|
|
nameWithType: "ShareProperties.getMetadata()"
|
|
summary: "Get the metadata property: The metadata property."
|
|
syntax: "public Map<String,String> getMetadata()"
|
|
desc: "Get the metadata property: The metadata property."
|
|
returns:
|
|
description: "the metadata value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getNextAllowedQuotaDowngradeTime()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getNextAllowedQuotaDowngradeTime()"
|
|
name: "getNextAllowedQuotaDowngradeTime()"
|
|
nameWithType: "ShareProperties.getNextAllowedQuotaDowngradeTime()"
|
|
summary: "Get the next<wbr>Allowed<wbr>Quota<wbr>Downgrade<wbr>Time property: The next<wbr>Allowed<wbr>Quota<wbr>Downgrade<wbr>Time property."
|
|
syntax: "public OffsetDateTime getNextAllowedQuotaDowngradeTime()"
|
|
desc: "Get the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property."
|
|
returns:
|
|
description: "the nextAllowedQuotaDowngradeTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getPaidBurstingMaxBandwidthMibps()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getPaidBurstingMaxBandwidthMibps()"
|
|
name: "getPaidBurstingMaxBandwidthMibps()"
|
|
nameWithType: "ShareProperties.getPaidBurstingMaxBandwidthMibps()"
|
|
summary: "Get the paid<wbr>Bursting<wbr>Max<wbr>Bandwidth<wbr>Mibps property: Optional."
|
|
syntax: "public Long getPaidBurstingMaxBandwidthMibps()"
|
|
desc: "Get the paidBurstingMaxBandwidthMibps property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec."
|
|
returns:
|
|
description: "the paidBurstingMaxBandwidthMibps value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getPaidBurstingMaxIops()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getPaidBurstingMaxIops()"
|
|
name: "getPaidBurstingMaxIops()"
|
|
nameWithType: "ShareProperties.getPaidBurstingMaxIops()"
|
|
summary: "Get the paid<wbr>Bursting<wbr>Max<wbr>Iops property: Optional."
|
|
syntax: "public Long getPaidBurstingMaxIops()"
|
|
desc: "Get the paidBurstingMaxIops property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS."
|
|
returns:
|
|
description: "the paidBurstingMaxIops value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getProtocols()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getProtocols()"
|
|
name: "getProtocols()"
|
|
nameWithType: "ShareProperties.getProtocols()"
|
|
summary: "Get the enabled<wbr>Protocols property: The enabled<wbr>Protocols property."
|
|
syntax: "public ShareProtocols getProtocols()"
|
|
desc: "Get the enabledProtocols property: The enabledProtocols property."
|
|
returns:
|
|
description: "the enabledProtocols value."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProtocols?alt=com.azure.storage.file.share.models.ShareProtocols&text=ShareProtocols\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getProvisionedBandwidthMiBps()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getProvisionedBandwidthMiBps()"
|
|
name: "getProvisionedBandwidthMiBps()"
|
|
nameWithType: "ShareProperties.getProvisionedBandwidthMiBps()"
|
|
summary: "Get the provisioned<wbr>Bandwidth<wbr>MiBps property: The Provisioned<wbr>Bandwidth<wbr>MiBps property."
|
|
syntax: "public Integer getProvisionedBandwidthMiBps()"
|
|
desc: "Get the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property."
|
|
returns:
|
|
description: "the provisionedBandwidthMiBps value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getProvisionedEgressMBps()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getProvisionedEgressMBps()"
|
|
name: "getProvisionedEgressMBps()"
|
|
nameWithType: "ShareProperties.getProvisionedEgressMBps()"
|
|
summary: "Get the provisioned<wbr>Egress<wbr>MBps property: The provisioned<wbr>Egress<wbr>MBps property."
|
|
deprecatedTag: "Please use <xref uid=\"com.azure.storage.file.share.models.ShareProperties.getProvisionedBandwidthMiBps()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getProvisionedBandwidthMiBps()\"></xref>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Integer getProvisionedEgressMBps()"
|
|
desc: "Get the provisionedEgressMBps property: The provisionedEgressMBps property."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the provisionedEgressMBps value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getProvisionedIngressMBps()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getProvisionedIngressMBps()"
|
|
name: "getProvisionedIngressMBps()"
|
|
nameWithType: "ShareProperties.getProvisionedIngressMBps()"
|
|
summary: "Get the provisioned<wbr>Ingress<wbr>MBps property: The provisioned<wbr>Ingress<wbr>MBps property."
|
|
deprecatedTag: "Please use <xref uid=\"com.azure.storage.file.share.models.ShareProperties.getProvisionedBandwidthMiBps()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getProvisionedBandwidthMiBps()\"></xref>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Integer getProvisionedIngressMBps()"
|
|
desc: "Get the provisionedIngressMBps property: The provisionedIngressMBps property."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the provisionedIngressMBps value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getProvisionedIops()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getProvisionedIops()"
|
|
name: "getProvisionedIops()"
|
|
nameWithType: "ShareProperties.getProvisionedIops()"
|
|
summary: "Get the provisioned<wbr>Iops property: The provisioned<wbr>Iops property."
|
|
syntax: "public Integer getProvisionedIops()"
|
|
desc: "Get the provisionedIops property: The provisionedIops property."
|
|
returns:
|
|
description: "the provisionedIops value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getQuota()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getQuota()"
|
|
name: "getQuota()"
|
|
nameWithType: "ShareProperties.getQuota()"
|
|
summary: "Get the quota property: The quota property."
|
|
syntax: "public int getQuota()"
|
|
desc: "Get the quota property: The quota property."
|
|
returns:
|
|
description: "the quota value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getRemainingRetentionDays()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getRemainingRetentionDays()"
|
|
name: "getRemainingRetentionDays()"
|
|
nameWithType: "ShareProperties.getRemainingRetentionDays()"
|
|
summary: "Get the remaining<wbr>Retention<wbr>Days property: The remaining<wbr>Retention<wbr>Days property."
|
|
syntax: "public Integer getRemainingRetentionDays()"
|
|
desc: "Get the remainingRetentionDays property: The remainingRetentionDays property."
|
|
returns:
|
|
description: "the remainingRetentionDays value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.getRootSquash()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.getRootSquash()"
|
|
name: "getRootSquash()"
|
|
nameWithType: "ShareProperties.getRootSquash()"
|
|
summary: "Get the root<wbr>Squash property: Possible values include: 'No<wbr>Root<wbr>Squash', 'Root<wbr>Squash', 'All<wbr>Squash'."
|
|
syntax: "public ShareRootSquash getRootSquash()"
|
|
desc: "Get the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'."
|
|
returns:
|
|
description: "the rootSquash value."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareRootSquash?alt=com.azure.storage.file.share.models.ShareRootSquash&text=ShareRootSquash\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.isPaidBurstingEnabled()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.isPaidBurstingEnabled()"
|
|
name: "isPaidBurstingEnabled()"
|
|
nameWithType: "ShareProperties.isPaidBurstingEnabled()"
|
|
summary: "Get the enable<wbr>Paid<wbr>Bursting property: Optional."
|
|
syntax: "public Boolean isPaidBurstingEnabled()"
|
|
desc: "Get the enablePaidBursting property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. This property enables paid bursting on premium file storage accounts."
|
|
returns:
|
|
description: "the enablePaidBursting value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.isSnapshotVirtualDirectoryAccessEnabled()"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.isSnapshotVirtualDirectoryAccessEnabled()"
|
|
name: "isSnapshotVirtualDirectoryAccessEnabled()"
|
|
nameWithType: "ShareProperties.isSnapshotVirtualDirectoryAccessEnabled()"
|
|
summary: "Get the enable<wbr>Snapshot<wbr>Virtual<wbr>Directory<wbr>Access property: Optional."
|
|
syntax: "public Boolean isSnapshotVirtualDirectoryAccessEnabled()"
|
|
desc: "Get the enableSnapshotVirtualDirectoryAccess property: Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. If not specified, the default is true."
|
|
returns:
|
|
description: "the enableSnapshotVirtualDirectoryAccess value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setAccessTier(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setAccessTier(String accessTier)"
|
|
name: "setAccessTier(String accessTier)"
|
|
nameWithType: "ShareProperties.setAccessTier(String accessTier)"
|
|
summary: "Set the access<wbr>Tier property: The access<wbr>Tier property."
|
|
parameters:
|
|
- description: "the accessTier value to set."
|
|
name: "accessTier"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareProperties setAccessTier(String accessTier)"
|
|
desc: "Set the accessTier property: The accessTier property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setAccessTierChangeTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setAccessTierChangeTime(OffsetDateTime accessTierChangeTime)"
|
|
name: "setAccessTierChangeTime(OffsetDateTime accessTierChangeTime)"
|
|
nameWithType: "ShareProperties.setAccessTierChangeTime(OffsetDateTime accessTierChangeTime)"
|
|
summary: "Set the access<wbr>Tier<wbr>Change<wbr>Time property: The access<wbr>Tier<wbr>Change<wbr>Time property."
|
|
parameters:
|
|
- description: "the accessTierChangeTime value to set."
|
|
name: "accessTierChangeTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public ShareProperties setAccessTierChangeTime(OffsetDateTime accessTierChangeTime)"
|
|
desc: "Set the accessTierChangeTime property: The accessTierChangeTime property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setAccessTierTransitionState(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setAccessTierTransitionState(String accessTierTransitionState)"
|
|
name: "setAccessTierTransitionState(String accessTierTransitionState)"
|
|
nameWithType: "ShareProperties.setAccessTierTransitionState(String accessTierTransitionState)"
|
|
summary: "Set the access<wbr>Tier<wbr>Transition<wbr>State property: The access<wbr>Tier<wbr>Transition<wbr>State property."
|
|
parameters:
|
|
- description: "the accessTierTransitionState value to\n set."
|
|
name: "accessTierTransitionState"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareProperties setAccessTierTransitionState(String accessTierTransitionState)"
|
|
desc: "Set the accessTierTransitionState property: The accessTierTransitionState property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setDeletedTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setDeletedTime(OffsetDateTime deletedTime)"
|
|
name: "setDeletedTime(OffsetDateTime deletedTime)"
|
|
nameWithType: "ShareProperties.setDeletedTime(OffsetDateTime deletedTime)"
|
|
summary: "Set the deleted<wbr>Time property: The deleted<wbr>Time property."
|
|
parameters:
|
|
- description: "the deletedTime value to set."
|
|
name: "deletedTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public ShareProperties setDeletedTime(OffsetDateTime deletedTime)"
|
|
desc: "Set the deletedTime property: The deletedTime property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setETag(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setETag(String eTag)"
|
|
name: "setETag(String eTag)"
|
|
nameWithType: "ShareProperties.setETag(String eTag)"
|
|
summary: "Set the e<wbr>Tag property: The e<wbr>Tag property."
|
|
parameters:
|
|
- description: "the eTag value to set."
|
|
name: "eTag"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareProperties setETag(String eTag)"
|
|
desc: "Set the eTag property: The eTag property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setLastModified(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setLastModified(OffsetDateTime lastModified)"
|
|
name: "setLastModified(OffsetDateTime lastModified)"
|
|
nameWithType: "ShareProperties.setLastModified(OffsetDateTime lastModified)"
|
|
summary: "Set the last<wbr>Modified property: The last<wbr>Modified property."
|
|
parameters:
|
|
- description: "the lastModified value to set."
|
|
name: "lastModified"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public ShareProperties setLastModified(OffsetDateTime lastModified)"
|
|
desc: "Set the lastModified property: The lastModified property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setLeaseDuration(com.azure.storage.file.share.models.LeaseDurationType)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setLeaseDuration(LeaseDurationType leaseDuration)"
|
|
name: "setLeaseDuration(LeaseDurationType leaseDuration)"
|
|
nameWithType: "ShareProperties.setLeaseDuration(LeaseDurationType leaseDuration)"
|
|
summary: "Set the lease<wbr>Duration property: Possible values include: 'infinite', 'fixed'."
|
|
parameters:
|
|
- description: "the leaseDuration value to set."
|
|
name: "leaseDuration"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.LeaseDurationType?alt=com.azure.storage.file.share.models.LeaseDurationType&text=LeaseDurationType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareProperties setLeaseDuration(LeaseDurationType leaseDuration)"
|
|
desc: "Set the leaseDuration property: Possible values include: 'infinite', 'fixed'."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setLeaseState(com.azure.storage.file.share.models.LeaseStateType)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setLeaseState(LeaseStateType leaseState)"
|
|
name: "setLeaseState(LeaseStateType leaseState)"
|
|
nameWithType: "ShareProperties.setLeaseState(LeaseStateType leaseState)"
|
|
summary: "Set the lease<wbr>State property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
|
|
parameters:
|
|
- description: "the leaseState value to set."
|
|
name: "leaseState"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.LeaseStateType?alt=com.azure.storage.file.share.models.LeaseStateType&text=LeaseStateType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareProperties setLeaseState(LeaseStateType leaseState)"
|
|
desc: "Set the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setLeaseStatus(com.azure.storage.file.share.models.LeaseStatusType)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setLeaseStatus(LeaseStatusType leaseStatus)"
|
|
name: "setLeaseStatus(LeaseStatusType leaseStatus)"
|
|
nameWithType: "ShareProperties.setLeaseStatus(LeaseStatusType leaseStatus)"
|
|
summary: "Set the lease<wbr>Status property: Possible values include: 'locked', 'unlocked'."
|
|
parameters:
|
|
- description: "the leaseStatus value to set."
|
|
name: "leaseStatus"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.LeaseStatusType?alt=com.azure.storage.file.share.models.LeaseStatusType&text=LeaseStatusType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareProperties setLeaseStatus(LeaseStatusType leaseStatus)"
|
|
desc: "Set the leaseStatus property: Possible values include: 'locked', 'unlocked'."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setMetadata(Map<String,String> metadata)"
|
|
name: "setMetadata(Map<String,String> metadata)"
|
|
nameWithType: "ShareProperties.setMetadata(Map<String,String> metadata)"
|
|
summary: "Set the metadata property: The metadata property."
|
|
parameters:
|
|
- description: "the metadata value to set."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public ShareProperties setMetadata(Map<String,String> metadata)"
|
|
desc: "Set the metadata property: The metadata property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setNextAllowedQuotaDowngradeTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime)"
|
|
name: "setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime)"
|
|
nameWithType: "ShareProperties.setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime)"
|
|
summary: "Set the next<wbr>Allowed<wbr>Quota<wbr>Downgrade<wbr>Time property: The next<wbr>Allowed<wbr>Quota<wbr>Downgrade<wbr>Time property."
|
|
parameters:
|
|
- description: "the nextAllowedQuotaDowngradeTime\n value to set."
|
|
name: "nextAllowedQuotaDowngradeTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public ShareProperties setNextAllowedQuotaDowngradeTime(OffsetDateTime nextAllowedQuotaDowngradeTime)"
|
|
desc: "Set the nextAllowedQuotaDowngradeTime property: The nextAllowedQuotaDowngradeTime property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setPaidBurstingEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setPaidBurstingEnabled(Boolean enablePaidBursting)"
|
|
name: "setPaidBurstingEnabled(Boolean enablePaidBursting)"
|
|
nameWithType: "ShareProperties.setPaidBurstingEnabled(Boolean enablePaidBursting)"
|
|
summary: "Set the enable<wbr>Paid<wbr>Bursting property: Optional."
|
|
parameters:
|
|
- description: "the enablePaidBursting value to set."
|
|
name: "enablePaidBursting"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ShareProperties setPaidBurstingEnabled(Boolean enablePaidBursting)"
|
|
desc: "Set the enablePaidBursting property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. This property enables paid bursting on premium file storage accounts."
|
|
returns:
|
|
description: "the ShareSetPropertiesOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setPaidBurstingMaxBandwidthMibps(java.lang.Long)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps)"
|
|
name: "setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps)"
|
|
nameWithType: "ShareProperties.setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps)"
|
|
summary: "Set the paid<wbr>Bursting<wbr>Max<wbr>Bandwidth<wbr>Mibps property: Optional."
|
|
parameters:
|
|
- description: "the paidBurstingMaxBandwidthMibps value to set."
|
|
name: "paidBurstingMaxBandwidthMibps"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
syntax: "public ShareProperties setPaidBurstingMaxBandwidthMibps(Long paidBurstingMaxBandwidthMibps)"
|
|
desc: "Set the paidBurstingMaxBandwidthMibps property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec."
|
|
returns:
|
|
description: "the ShareSetPropertiesOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setPaidBurstingMaxIops(java.lang.Long)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setPaidBurstingMaxIops(Long paidBurstingMaxIops)"
|
|
name: "setPaidBurstingMaxIops(Long paidBurstingMaxIops)"
|
|
nameWithType: "ShareProperties.setPaidBurstingMaxIops(Long paidBurstingMaxIops)"
|
|
summary: "Set the paid<wbr>Bursting<wbr>Max<wbr>Iops property: Optional."
|
|
parameters:
|
|
- description: "the paidBurstingMaxIops value to set."
|
|
name: "paidBurstingMaxIops"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
syntax: "public ShareProperties setPaidBurstingMaxIops(Long paidBurstingMaxIops)"
|
|
desc: "Set the paidBurstingMaxIops property: Optional. Supported in version 2023-11-03 and above. Only applicable for premium file storage accounts. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS."
|
|
returns:
|
|
description: "the ShareSetPropertiesOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setProtocols(com.azure.storage.file.share.models.ShareProtocols)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setProtocols(ShareProtocols protocols)"
|
|
name: "setProtocols(ShareProtocols protocols)"
|
|
nameWithType: "ShareProperties.setProtocols(ShareProtocols protocols)"
|
|
summary: "Set the enabled<wbr>Protocols property: The enabled<wbr>Protocols property."
|
|
parameters:
|
|
- description: "the enabledProtocols value to set."
|
|
name: "protocols"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProtocols?alt=com.azure.storage.file.share.models.ShareProtocols&text=ShareProtocols\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareProperties setProtocols(ShareProtocols protocols)"
|
|
desc: "Set the enabledProtocols property: The enabledProtocols property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setProvisionedBandwidthMiBps(java.lang.Integer)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps)"
|
|
name: "setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps)"
|
|
nameWithType: "ShareProperties.setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps)"
|
|
summary: "Set the provisioned<wbr>Bandwidth<wbr>MiBps property: The Provisioned<wbr>Bandwidth<wbr>MiBps property."
|
|
parameters:
|
|
- description: "the provisionedBandwidthMiBps value to set."
|
|
name: "provisionedBandwidthMiBps"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ShareProperties setProvisionedBandwidthMiBps(Integer provisionedBandwidthMiBps)"
|
|
desc: "Set the provisionedBandwidthMiBps property: The ProvisionedBandwidthMiBps property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setProvisionedEgressMBps(java.lang.Integer)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setProvisionedEgressMBps(Integer provisionedEgressMBps)"
|
|
name: "setProvisionedEgressMBps(Integer provisionedEgressMBps)"
|
|
nameWithType: "ShareProperties.setProvisionedEgressMBps(Integer provisionedEgressMBps)"
|
|
summary: "Set the provisioned<wbr>Egress<wbr>MBps property: The provisioned<wbr>Egress<wbr>MBps property."
|
|
deprecatedTag: "Please use <xref uid=\"com.azure.storage.file.share.models.ShareProperties.setProvisionedBandwidthMiBps(java.lang.Integer)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setProvisionedBandwidthMiBps(Integer)\"></xref> ()\\}"
|
|
parameters:
|
|
- description: "the provisionedEgressMBps value to set."
|
|
name: "provisionedEgressMBps"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareProperties setProvisionedEgressMBps(Integer provisionedEgressMBps)"
|
|
desc: "Set the provisionedEgressMBps property: The provisionedEgressMBps property."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setProvisionedIngressMBps(java.lang.Integer)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setProvisionedIngressMBps(Integer provisionedIngressMBps)"
|
|
name: "setProvisionedIngressMBps(Integer provisionedIngressMBps)"
|
|
nameWithType: "ShareProperties.setProvisionedIngressMBps(Integer provisionedIngressMBps)"
|
|
summary: "Set the provisioned<wbr>Ingress<wbr>MBps property: The provisioned<wbr>Ingress<wbr>MBps property."
|
|
deprecatedTag: "Please use <xref uid=\"com.azure.storage.file.share.models.ShareProperties.setProvisionedBandwidthMiBps(java.lang.Integer)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setProvisionedBandwidthMiBps(Integer)\"></xref> ()\\}"
|
|
parameters:
|
|
- description: "the provisionedIngressMBps value to set."
|
|
name: "provisionedIngressMBps"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareProperties setProvisionedIngressMBps(Integer provisionedIngressMBps)"
|
|
desc: "Set the provisionedIngressMBps property: The provisionedIngressMBps property."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setProvisionedIops(java.lang.Integer)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setProvisionedIops(Integer provisionedIops)"
|
|
name: "setProvisionedIops(Integer provisionedIops)"
|
|
nameWithType: "ShareProperties.setProvisionedIops(Integer provisionedIops)"
|
|
summary: "Set the provisioned<wbr>Iops property: The provisioned<wbr>Iops property."
|
|
parameters:
|
|
- description: "the provisionedIops value to set."
|
|
name: "provisionedIops"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ShareProperties setProvisionedIops(Integer provisionedIops)"
|
|
desc: "Set the provisionedIops property: The provisionedIops property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setQuota(int)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setQuota(int quota)"
|
|
name: "setQuota(int quota)"
|
|
nameWithType: "ShareProperties.setQuota(int quota)"
|
|
summary: "Set the quota property: The quota property."
|
|
parameters:
|
|
- description: "the quota value to set."
|
|
name: "quota"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareProperties setQuota(int quota)"
|
|
desc: "Set the quota property: The quota property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setRemainingRetentionDays(java.lang.Integer)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setRemainingRetentionDays(Integer remainingRetentionDays)"
|
|
name: "setRemainingRetentionDays(Integer remainingRetentionDays)"
|
|
nameWithType: "ShareProperties.setRemainingRetentionDays(Integer remainingRetentionDays)"
|
|
summary: "Set the remaining<wbr>Retention<wbr>Days property: The remaining<wbr>Retention<wbr>Days property."
|
|
parameters:
|
|
- description: "the remainingRetentionDays value to set."
|
|
name: "remainingRetentionDays"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ShareProperties setRemainingRetentionDays(Integer remainingRetentionDays)"
|
|
desc: "Set the remainingRetentionDays property: The remainingRetentionDays property."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setRootSquash(com.azure.storage.file.share.models.ShareRootSquash)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setRootSquash(ShareRootSquash rootSquash)"
|
|
name: "setRootSquash(ShareRootSquash rootSquash)"
|
|
nameWithType: "ShareProperties.setRootSquash(ShareRootSquash rootSquash)"
|
|
summary: "Set the root<wbr>Squash property: Possible values include: 'No<wbr>Root<wbr>Squash', 'Root<wbr>Squash', 'All<wbr>Squash'."
|
|
parameters:
|
|
- description: "the rootSquash value to set."
|
|
name: "rootSquash"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareRootSquash?alt=com.azure.storage.file.share.models.ShareRootSquash&text=ShareRootSquash\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareProperties setRootSquash(ShareRootSquash rootSquash)"
|
|
desc: "Set the rootSquash property: Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.setSnapshotVirtualDirectoryAccessEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.setSnapshotVirtualDirectoryAccessEnabled(Boolean enableSnapshotVirtualDirectoryAccess)"
|
|
name: "setSnapshotVirtualDirectoryAccessEnabled(Boolean enableSnapshotVirtualDirectoryAccess)"
|
|
nameWithType: "ShareProperties.setSnapshotVirtualDirectoryAccessEnabled(Boolean enableSnapshotVirtualDirectoryAccess)"
|
|
summary: "Set the enable<wbr>Snapshot<wbr>Virtual<wbr>Directory<wbr>Access property: Optional."
|
|
parameters:
|
|
- description: "the enableSnapshotVirtualDirectoryAccess value to set."
|
|
name: "enableSnapshotVirtualDirectoryAccess"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ShareProperties setSnapshotVirtualDirectoryAccessEnabled(Boolean enableSnapshotVirtualDirectoryAccess)"
|
|
desc: "Set the enableSnapshotVirtualDirectoryAccess property: Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. If not specified, the default is true."
|
|
returns:
|
|
description: "the ShareProperties object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.toXml(com.azure.xml.XmlWriter)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.toXml(XmlWriter xmlWriter)"
|
|
name: "toXml(XmlWriter xmlWriter)"
|
|
nameWithType: "ShareProperties.toXml(XmlWriter xmlWriter)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareProperties.toXml(com.azure.xml.XmlWriter,java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareProperties.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
name: "toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
nameWithType: "ShareProperties.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Properties of a share."
|
|
implements:
|
|
- "<xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.models.ShareProperties?alt=com.azure.storage.file.share.models.ShareProperties&text=ShareProperties\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.file.share.models"
|
|
artifact: com.azure:azure-storage-file-share:12.24.0
|