azure.mgmt.storage.v2021_01_01.models.FileShareItem.yml

### YamlMime:PythonClass
uid: azure.mgmt.storage.v2021_01_01.models.FileShareItem
name: FileShareItem
fullName: azure.mgmt.storage.v2021_01_01.models.FileShareItem
module: azure.mgmt.storage.v2021_01_01.models
inheritances:
- azure.mgmt.storage.v2021_01_01.models._models_py3.AzureEntityResource
summary: 'The file share properties be listed out.


  Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
  syntax: 'FileShareItem(*, metadata: Dict[str, str] | None = None, share_quota: int
    | None = None, enabled_protocols: str | _models.EnabledProtocols | None = None,
    root_squash: str | _models.RootSquashType | None = None, access_tier: str | _models.ShareAccessTier
    | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: metadata
    description: A name-value pair to associate with the share as metadata.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: share_quota
    description: '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.'
    types:
    - <xref:int>
  - name: enabled_protocols
    description: 'The authentication protocol that is used for the file share. Can

      only be specified when creating a share. Known values are: "SMB" and "NFS".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2021_01_01.models.EnabledProtocols>
  - name: root_squash
    description: 'The property is for NFS share only. The default is NoRootSquash.
      Known

      values are: "NoRootSquash", "RootSquash", and "AllSquash".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2021_01_01.models.RootSquashType>
  - name: access_tier
    description: 'Access tier for specific share. GpV2 account can choose between

      TransactionOptimized (default), Hot, and Cool. FileStorage account can choose
      Premium. Known

      values are: "TransactionOptimized", "Hot", "Cool", and "Premium".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2021_01_01.models.ShareAccessTier>
variables:
- description: 'Fully qualified resource ID for the resource. Ex -

    /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.  #
    pylint: disable=line-too-long'
  name: id
  types:
  - <xref:str>
- description: The name of the resource.
  name: name
  types:
  - <xref:str>
- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
    or

    "Microsoft.Storage/storageAccounts".'
  name: type
  types:
  - <xref:str>
- description: Resource Etag.
  name: etag
  types:
  - <xref:str>
- description: Returns the date and time the share was last modified.
  name: last_modified_time
  types:
  - <xref:datetime.datetime>
- description: A name-value pair to associate with the share as metadata.
  name: metadata
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: '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.'
  name: share_quota
  types:
  - <xref:int>
- description: 'The authentication protocol that is used for the file share. Can only

    be specified when creating a share. Known values are: "SMB" and "NFS".'
  name: enabled_protocols
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2021_01_01.models.EnabledProtocols>
- description: 'The property is for NFS share only. The default is NoRootSquash. Known

    values are: "NoRootSquash", "RootSquash", and "AllSquash".'
  name: root_squash
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2021_01_01.models.RootSquashType>
- description: The version of the share.
  name: version
  types:
  - <xref:str>
- description: Indicates whether the share was deleted.
  name: deleted
  types:
  - <xref:bool>
- description: The deleted time if the share was deleted.
  name: deleted_time
  types:
  - <xref:datetime.datetime>
- description: Remaining retention days for share that was soft deleted.
  name: remaining_retention_days
  types:
  - <xref:int>
- description: 'Access tier for specific share. GpV2 account can choose between

    TransactionOptimized (default), Hot, and Cool. FileStorage account can choose
    Premium. Known

    values are: "TransactionOptimized", "Hot", "Cool", and "Premium".'
  name: access_tier
  types:
  - <xref:str>
  - <xref:azure.mgmt.storage.v2021_01_01.models.ShareAccessTier>
- description: Indicates the last modification time for share access tier.
  name: access_tier_change_time
  types:
  - <xref:datetime.datetime>
- description: Indicates if there is a pending transition for access tier.
  name: access_tier_status
  types:
  - <xref:str>
- description: 'The approximate size of the data stored on the share. Note that this

    value may not include all recently created or recently resized files.'
  name: share_usage_bytes
  types:
  - <xref:int>
- description: 'Creation time of share snapshot returned in the response of list shares

    with expand param "snapshots".'
  name: snapshot_time
  types:
  - <xref:datetime.datetime>