azure-mgmt-storage 21.1.0b1__py3-none-any.whl → 21.2.0__py3-none-any.whl

azure/mgmt/storage/v2023_01_01/aio/operations/_file_shares_operations.py

@@ -0,0 +1,1003 @@
+# pylint: disable=too-many-lines,too-many-statements
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+from io import IOBase
+import sys
+from typing import Any, AsyncIterable, Callable, Dict, IO, Optional, Type, TypeVar, Union, overload
+import urllib.parse
+
+from azure.core.async_paging import AsyncItemPaged, AsyncList
+from azure.core.exceptions import (
+    ClientAuthenticationError,
+    HttpResponseError,
+    ResourceExistsError,
+    ResourceNotFoundError,
+    ResourceNotModifiedError,
+    map_error,
+)
+from azure.core.pipeline import PipelineResponse
+from azure.core.pipeline.transport import AsyncHttpResponse
+from azure.core.rest import HttpRequest
+from azure.core.tracing.decorator import distributed_trace
+from azure.core.tracing.decorator_async import distributed_trace_async
+from azure.core.utils import case_insensitive_dict
+from azure.mgmt.core.exceptions import ARMErrorFormat
+
+from ... import models as _models
+from ..._vendor import _convert_request
+from ...operations._file_shares_operations import (
+    build_create_request,
+    build_delete_request,
+    build_get_request,
+    build_lease_request,
+    build_list_request,
+    build_restore_request,
+    build_update_request,
+)
+
+if sys.version_info >= (3, 9):
+    from collections.abc import MutableMapping
+else:
+    from typing import MutableMapping  # type: ignore  # pylint: disable=ungrouped-imports
+T = TypeVar("T")
+ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]]
+
+
+class FileSharesOperations:
+    """
+    .. warning::
+        **DO NOT** instantiate this class directly.
+
+        Instead, you should access the following operations through
+        :class:`~azure.mgmt.storage.v2023_01_01.aio.StorageManagementClient`'s
+        :attr:`file_shares` attribute.
+    """
+
+    models = _models
+
+    def __init__(self, *args, **kwargs) -> None:
+        input_args = list(args)
+        self._client = input_args.pop(0) if input_args else kwargs.pop("client")
+        self._config = input_args.pop(0) if input_args else kwargs.pop("config")
+        self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
+        self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
+        self._api_version = input_args.pop(0) if input_args else kwargs.pop("api_version")
+
+    @distributed_trace
+    def list(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        maxpagesize: Optional[str] = None,
+        filter: Optional[str] = None,
+        expand: Optional[str] = None,
+        **kwargs: Any
+    ) -> AsyncIterable["_models.FileShareItem"]:
+        """Lists all shares.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param maxpagesize: Optional. Specified maximum number of shares that can be included in the
+         list. Default value is None.
+        :type maxpagesize: str
+        :param filter: Optional. When specified, only share names starting with the filter will be
+         listed. Default value is None.
+        :type filter: str
+        :param expand: 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.
+        :type expand: str
+        :return: An iterator like instance of either FileShareItem or the result of cls(response)
+        :rtype:
+         ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.storage.v2023_01_01.models.FileShareItem]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        _headers = kwargs.pop("headers", {}) or {}
+        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+
+        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-01-01"))
+        cls: ClsType[_models.FileShareItems] = kwargs.pop("cls", None)
+
+        error_map: MutableMapping[int, Type[HttpResponseError]] = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        def prepare_request(next_link=None):
+            if not next_link:
+
+                _request = build_list_request(
+                    resource_group_name=resource_group_name,
+                    account_name=account_name,
+                    subscription_id=self._config.subscription_id,
+                    maxpagesize=maxpagesize,
+                    filter=filter,
+                    expand=expand,
+                    api_version=api_version,
+                    headers=_headers,
+                    params=_params,
+                )
+                _request = _convert_request(_request)
+                _request.url = self._client.format_url(_request.url)
+
+            else:
+                # make call to next link with the client's api-version
+                _parsed_next_link = urllib.parse.urlparse(next_link)
+                _next_request_params = case_insensitive_dict(
+                    {
+                        key: [urllib.parse.quote(v) for v in value]
+                        for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
+                    }
+                )
+                _next_request_params["api-version"] = self._api_version
+                _request = HttpRequest(
+                    "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
+                )
+                _request = _convert_request(_request)
+                _request.url = self._client.format_url(_request.url)
+                _request.method = "GET"
+            return _request
+
+        async def extract_data(pipeline_response):
+            deserialized = self._deserialize("FileShareItems", pipeline_response)
+            list_of_elem = deserialized.value
+            if cls:
+                list_of_elem = cls(list_of_elem)  # type: ignore
+            return deserialized.next_link or None, AsyncList(list_of_elem)
+
+        async def get_next(next_link=None):
+            _request = prepare_request(next_link)
+
+            _stream = False
+            pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+                _request, stream=_stream, **kwargs
+            )
+            response = pipeline_response.http_response
+
+            if response.status_code not in [200]:
+                map_error(status_code=response.status_code, response=response, error_map=error_map)
+                raise HttpResponseError(response=response, error_format=ARMErrorFormat)
+
+            return pipeline_response
+
+        return AsyncItemPaged(get_next, extract_data)
+
+    @overload
+    async def create(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        file_share: _models.FileShare,
+        expand: Optional[str] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> _models.FileShare:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param file_share: Properties of the file share to create. Required.
+        :type file_share: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :param expand: 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.
+        :type expand: str
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: FileShare or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def create(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        file_share: IO[bytes],
+        expand: Optional[str] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> _models.FileShare:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param file_share: Properties of the file share to create. Required.
+        :type file_share: IO[bytes]
+        :param expand: 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.
+        :type expand: str
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: FileShare or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @distributed_trace_async
+    async def create(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        file_share: Union[_models.FileShare, IO[bytes]],
+        expand: Optional[str] = None,
+        **kwargs: Any
+    ) -> _models.FileShare:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param file_share: Properties of the file share to create. Is either a FileShare type or a
+         IO[bytes] type. Required.
+        :type file_share: ~azure.mgmt.storage.v2023_01_01.models.FileShare or IO[bytes]
+        :param expand: 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.
+        :type expand: str
+        :return: FileShare or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping[int, Type[HttpResponseError]] = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+
+        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-01-01"))
+        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
+        cls: ClsType[_models.FileShare] = kwargs.pop("cls", None)
+
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(file_share, (IOBase, bytes)):
+            _content = file_share
+        else:
+            _json = self._serialize.body(file_share, "FileShare")
+
+        _request = build_create_request(
+            resource_group_name=resource_group_name,
+            account_name=account_name,
+            share_name=share_name,
+            subscription_id=self._config.subscription_id,
+            expand=expand,
+            api_version=api_version,
+            content_type=content_type,
+            json=_json,
+            content=_content,
+            headers=_headers,
+            params=_params,
+        )
+        _request = _convert_request(_request)
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200, 201]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response, error_format=ARMErrorFormat)
+
+        if response.status_code == 200:
+            deserialized = self._deserialize("FileShare", pipeline_response)
+
+        if response.status_code == 201:
+            deserialized = self._deserialize("FileShare", pipeline_response)
+
+        if cls:
+            return cls(pipeline_response, deserialized, {})  # type: ignore
+
+        return deserialized  # type: ignore
+
+    @overload
+    async def update(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        file_share: _models.FileShare,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> _models.FileShare:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param file_share: Properties to update for the file share. Required.
+        :type file_share: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: FileShare or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def update(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        file_share: IO[bytes],
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> _models.FileShare:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param file_share: Properties to update for the file share. Required.
+        :type file_share: IO[bytes]
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: FileShare or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @distributed_trace_async
+    async def update(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        file_share: Union[_models.FileShare, IO[bytes]],
+        **kwargs: Any
+    ) -> _models.FileShare:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param file_share: Properties to update for the file share. Is either a FileShare type or a
+         IO[bytes] type. Required.
+        :type file_share: ~azure.mgmt.storage.v2023_01_01.models.FileShare or IO[bytes]
+        :return: FileShare or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping[int, Type[HttpResponseError]] = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+
+        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-01-01"))
+        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
+        cls: ClsType[_models.FileShare] = kwargs.pop("cls", None)
+
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(file_share, (IOBase, bytes)):
+            _content = file_share
+        else:
+            _json = self._serialize.body(file_share, "FileShare")
+
+        _request = build_update_request(
+            resource_group_name=resource_group_name,
+            account_name=account_name,
+            share_name=share_name,
+            subscription_id=self._config.subscription_id,
+            api_version=api_version,
+            content_type=content_type,
+            json=_json,
+            content=_content,
+            headers=_headers,
+            params=_params,
+        )
+        _request = _convert_request(_request)
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response, error_format=ARMErrorFormat)
+
+        deserialized = self._deserialize("FileShare", pipeline_response)
+
+        if cls:
+            return cls(pipeline_response, deserialized, {})  # type: ignore
+
+        return deserialized  # type: ignore
+
+    @distributed_trace_async
+    async def get(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        expand: Optional[str] = None,
+        x_ms_snapshot: Optional[str] = None,
+        **kwargs: Any
+    ) -> _models.FileShare:
+        """Gets properties of a specified share.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param expand: 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.
+        :type expand: str
+        :param x_ms_snapshot: Optional, used to retrieve properties of a snapshot. Default value is
+         None.
+        :type x_ms_snapshot: str
+        :return: FileShare or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.FileShare
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping[int, Type[HttpResponseError]] = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = kwargs.pop("headers", {}) or {}
+        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+
+        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-01-01"))
+        cls: ClsType[_models.FileShare] = kwargs.pop("cls", None)
+
+        _request = build_get_request(
+            resource_group_name=resource_group_name,
+            account_name=account_name,
+            share_name=share_name,
+            subscription_id=self._config.subscription_id,
+            expand=expand,
+            x_ms_snapshot=x_ms_snapshot,
+            api_version=api_version,
+            headers=_headers,
+            params=_params,
+        )
+        _request = _convert_request(_request)
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response, error_format=ARMErrorFormat)
+
+        deserialized = self._deserialize("FileShare", pipeline_response)
+
+        if cls:
+            return cls(pipeline_response, deserialized, {})  # type: ignore
+
+        return deserialized  # type: ignore
+
+    @distributed_trace_async
+    async def delete(  # pylint: disable=inconsistent-return-statements
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        x_ms_snapshot: Optional[str] = None,
+        include: Optional[str] = None,
+        **kwargs: Any
+    ) -> None:
+        """Deletes specified share under its account.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param x_ms_snapshot: Optional, used to delete a snapshot. Default value is None.
+        :type x_ms_snapshot: str
+        :param include: 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.
+        :type include: str
+        :return: None or the result of cls(response)
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping[int, Type[HttpResponseError]] = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = kwargs.pop("headers", {}) or {}
+        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+
+        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-01-01"))
+        cls: ClsType[None] = kwargs.pop("cls", None)
+
+        _request = build_delete_request(
+            resource_group_name=resource_group_name,
+            account_name=account_name,
+            share_name=share_name,
+            subscription_id=self._config.subscription_id,
+            x_ms_snapshot=x_ms_snapshot,
+            include=include,
+            api_version=api_version,
+            headers=_headers,
+            params=_params,
+        )
+        _request = _convert_request(_request)
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200, 204]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response, error_format=ARMErrorFormat)
+
+        if cls:
+            return cls(pipeline_response, None, {})  # type: ignore
+
+    @overload
+    async def restore(  # pylint: disable=inconsistent-return-statements
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        deleted_share: _models.DeletedShare,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> None:
+        """Restore a file share within a valid retention days if share soft delete is enabled.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param deleted_share: Required.
+        :type deleted_share: ~azure.mgmt.storage.v2023_01_01.models.DeletedShare
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: None or the result of cls(response)
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def restore(  # pylint: disable=inconsistent-return-statements
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        deleted_share: IO[bytes],
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> None:
+        """Restore a file share within a valid retention days if share soft delete is enabled.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param deleted_share: Required.
+        :type deleted_share: IO[bytes]
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: None or the result of cls(response)
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @distributed_trace_async
+    async def restore(  # pylint: disable=inconsistent-return-statements
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        deleted_share: Union[_models.DeletedShare, IO[bytes]],
+        **kwargs: Any
+    ) -> None:
+        """Restore a file share within a valid retention days if share soft delete is enabled.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param deleted_share: Is either a DeletedShare type or a IO[bytes] type. Required.
+        :type deleted_share: ~azure.mgmt.storage.v2023_01_01.models.DeletedShare or IO[bytes]
+        :return: None or the result of cls(response)
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping[int, Type[HttpResponseError]] = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+
+        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-01-01"))
+        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
+        cls: ClsType[None] = kwargs.pop("cls", None)
+
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(deleted_share, (IOBase, bytes)):
+            _content = deleted_share
+        else:
+            _json = self._serialize.body(deleted_share, "DeletedShare")
+
+        _request = build_restore_request(
+            resource_group_name=resource_group_name,
+            account_name=account_name,
+            share_name=share_name,
+            subscription_id=self._config.subscription_id,
+            api_version=api_version,
+            content_type=content_type,
+            json=_json,
+            content=_content,
+            headers=_headers,
+            params=_params,
+        )
+        _request = _convert_request(_request)
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response, error_format=ARMErrorFormat)
+
+        if cls:
+            return cls(pipeline_response, None, {})  # type: ignore
+
+    @overload
+    async def lease(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        x_ms_snapshot: Optional[str] = None,
+        parameters: Optional[_models.LeaseShareRequest] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> _models.LeaseShareResponse:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param x_ms_snapshot: Optional. Specify the snapshot time to lease a snapshot. Default value is
+         None.
+        :type x_ms_snapshot: str
+        :param parameters: Lease Share request body. Default value is None.
+        :type parameters: ~azure.mgmt.storage.v2023_01_01.models.LeaseShareRequest
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: LeaseShareResponse or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.LeaseShareResponse
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def lease(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        x_ms_snapshot: Optional[str] = None,
+        parameters: Optional[IO[bytes]] = None,
+        *,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> _models.LeaseShareResponse:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param x_ms_snapshot: Optional. Specify the snapshot time to lease a snapshot. Default value is
+         None.
+        :type x_ms_snapshot: str
+        :param parameters: Lease Share request body. Default value is None.
+        :type parameters: IO[bytes]
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: LeaseShareResponse or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.LeaseShareResponse
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @distributed_trace_async
+    async def lease(
+        self,
+        resource_group_name: str,
+        account_name: str,
+        share_name: str,
+        x_ms_snapshot: Optional[str] = None,
+        parameters: Optional[Union[_models.LeaseShareRequest, IO[bytes]]] = None,
+        **kwargs: Any
+    ) -> _models.LeaseShareResponse:
+        """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.
+
+        :param resource_group_name: The name of the resource group within the user's subscription. The
+         name is case insensitive. Required.
+        :type resource_group_name: str
+        :param account_name: 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.
+        :type account_name: str
+        :param share_name: 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.
+        :type share_name: str
+        :param x_ms_snapshot: Optional. Specify the snapshot time to lease a snapshot. Default value is
+         None.
+        :type x_ms_snapshot: str
+        :param parameters: Lease Share request body. Is either a LeaseShareRequest type or a IO[bytes]
+         type. Default value is None.
+        :type parameters: ~azure.mgmt.storage.v2023_01_01.models.LeaseShareRequest or IO[bytes]
+        :return: LeaseShareResponse or the result of cls(response)
+        :rtype: ~azure.mgmt.storage.v2023_01_01.models.LeaseShareResponse
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping[int, Type[HttpResponseError]] = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+        _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
+
+        api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._api_version or "2023-01-01"))
+        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
+        cls: ClsType[_models.LeaseShareResponse] = kwargs.pop("cls", None)
+
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(parameters, (IOBase, bytes)):
+            _content = parameters
+        else:
+            if parameters is not None:
+                _json = self._serialize.body(parameters, "LeaseShareRequest")
+            else:
+                _json = None
+
+        _request = build_lease_request(
+            resource_group_name=resource_group_name,
+            account_name=account_name,
+            share_name=share_name,
+            subscription_id=self._config.subscription_id,
+            x_ms_snapshot=x_ms_snapshot,
+            api_version=api_version,
+            content_type=content_type,
+            json=_json,
+            content=_content,
+            headers=_headers,
+            params=_params,
+        )
+        _request = _convert_request(_request)
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response, error_format=ARMErrorFormat)
+
+        response_headers = {}
+        response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag"))
+
+        deserialized = self._deserialize("LeaseShareResponse", pipeline_response)
+
+        if cls:
+            return cls(pipeline_response, deserialized, response_headers)  # type: ignore
+
+        return deserialized  # type: ignore