azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations
name: FileSharesOperations
fullName: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations
module: azure.mgmt.storage.v2021_09_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.storage.v2021_09_01.StorageManagementClient>'s\n\
  >\n> <xref:file_shares> attribute.\n>"
constructor:
  syntax: FileSharesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.create
  name: create
  summary: 'Creates a new share under the specified account as described by request
    body. The share

    resource includes metadata and properties for that share. It does not include
    a list of the

    files contained by the share.'
  signature: 'create(resource_group_name: str, account_name: str, share_name: str,
    file_share: _models.FileShare, expand: str | None = None, *, content_type: str
    = ''application/json'', **kwargs: Any) -> _models.FileShare'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: share_name
    description: 'The name of the file share within the specified storage account.
      File share

      names must be between 3 and 63 characters in length and use numbers, lower-case
      letters and

      dash (-) only. Every dash (-) character must be immediately preceded and followed
      by a letter

      or number. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: file_share
    description: 'Properties of the file share to create. Is either a FileShare type
      or a

      IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.FileShare>
    - <xref:typing.IO>[<xref:bytes>]
  - name: expand
    description: 'Optional, used to expand the properties within share''s properties.
      Valid values

      are: snapshots. Should be passed as a string with delimiter '',''. Default value
      is None.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: FileShare or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.FileShare>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.delete
  name: delete
  summary: Deletes specified share under its account.
  signature: 'delete(resource_group_name: str, account_name: str, share_name: str,
    x_ms_snapshot: str | None = None, include: str | None = None, **kwargs: Any) ->
    None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: share_name
    description: 'The name of the file share within the specified storage account.
      File share

      names must be between 3 and 63 characters in length and use numbers, lower-case
      letters and

      dash (-) only. Every dash (-) character must be immediately preceded and followed
      by a letter

      or number. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: x_ms_snapshot
    description: Optional, used to delete a snapshot. Default value is None.
    isRequired: true
    types:
    - <xref:str>
  - name: include
    description: 'Optional. Valid values are: snapshots, leased-snapshots, none. The
      default

      value is snapshots. For ''snapshots'', the file share is deleted including all
      of its file share

      snapshots. If the file share contains leased-snapshots, the deletion fails.
      For

      ''leased-snapshots'', the file share is deleted included all of its file share
      snapshots

      (leased/unleased). For ''none'', the file share is deleted if it has no share
      snapshots. If the

      file share contains any snapshots (leased or unleased), the deletion fails.
      Default value is

      None.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.get
  name: get
  summary: Gets properties of a specified share.
  signature: 'get(resource_group_name: str, account_name: str, share_name: str, expand:
    str | None = None, x_ms_snapshot: str | None = None, **kwargs: Any) -> FileShare'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: share_name
    description: 'The name of the file share within the specified storage account.
      File share

      names must be between 3 and 63 characters in length and use numbers, lower-case
      letters and

      dash (-) only. Every dash (-) character must be immediately preceded and followed
      by a letter

      or number. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: 'Optional, used to expand the properties within share''s properties.
      Valid values

      are: stats. Should be passed as a string with delimiter '',''. Default value
      is None.'
    isRequired: true
    types:
    - <xref:str>
  - name: x_ms_snapshot
    description: 'Optional, used to retrieve properties of a snapshot. Default value
      is

      None.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: FileShare or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.FileShare>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.lease
  name: lease
  summary: 'The Lease Share operation establishes and manages a lock on a share for
    delete operations. The

    lock duration can be 15 to 60 seconds, or can be infinite.'
  signature: 'lease(resource_group_name: str, account_name: str, share_name: str,
    x_ms_snapshot: str | None = None, parameters: _models.LeaseShareRequest | None
    = None, *, content_type: str = ''application/json'', **kwargs: Any) -> _models.LeaseShareResponse'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: share_name
    description: 'The name of the file share within the specified storage account.
      File share

      names must be between 3 and 63 characters in length and use numbers, lower-case
      letters and

      dash (-) only. Every dash (-) character must be immediately preceded and followed
      by a letter

      or number. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: x_ms_snapshot
    description: 'Optional. Specify the snapshot time to lease a snapshot. Default
      value is

      None.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Lease Share request body. Is either a LeaseShareRequest type or
      a IO[bytes]

      type. Default value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.LeaseShareRequest>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: LeaseShareResponse or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.LeaseShareResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.list
  name: list
  summary: Lists all shares.
  signature: 'list(resource_group_name: str, account_name: str, maxpagesize: str |
    None = None, filter: str | None = None, expand: str | None = None, **kwargs: Any)
    -> Iterable[FileShareItem]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: maxpagesize
    description: 'Optional. Specified maximum number of shares that can be included
      in the

      list. Default value is None.'
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'Optional. When specified, only share names starting with the filter
      will be

      listed. Default value is None.'
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: 'Optional, used to expand the properties within share''s properties.
      Valid values

      are: deleted, snapshots. Should be passed as a string with delimiter '',''.
      Default value is

      None.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either FileShareItem or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.storage.v2021_09_01.models.FileShareItem>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.restore
  name: restore
  summary: Restore a file share within a valid retention days if share soft delete
    is enabled.
  signature: 'restore(resource_group_name: str, account_name: str, share_name: str,
    deleted_share: _models.DeletedShare, *, content_type: str = ''application/json'',
    **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: share_name
    description: 'The name of the file share within the specified storage account.
      File share

      names must be between 3 and 63 characters in length and use numbers, lower-case
      letters and

      dash (-) only. Every dash (-) character must be immediately preceded and followed
      by a letter

      or number. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: deleted_share
    description: Is either a DeletedShare type or a IO[bytes] type. Required.
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.DeletedShare>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.update
  name: update
  summary: 'Updates share properties as specified in request body. Properties not
    mentioned in the request

    will not be changed. Update fails if the specified share does not already exist.'
  signature: 'update(resource_group_name: str, account_name: str, share_name: str,
    file_share: _models.FileShare, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.FileShare'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: 'The name of the storage account within the specified resource group.

      Storage account names must be between 3 and 24 characters in length and use
      numbers and

      lower-case letters only. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: share_name
    description: 'The name of the file share within the specified storage account.
      File share

      names must be between 3 and 63 characters in length and use numbers, lower-case
      letters and

      dash (-) only. Every dash (-) character must be immediately preceded and followed
      by a letter

      or number. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: file_share
    description: 'Properties to update for the file share. Is either a FileShare type
      or a

      IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.FileShare>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: FileShare or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2021_09_01.models.FileShare>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.storage.v2021_09_01.operations.FileSharesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.storage.v2021_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2021_09_01\\models\\__init__.py'>