docs-archive/apache-airflow-providers-microsoft-azure/3.0.0/_sources/_api/airflow/providers/microsoft/azure/hooks/azure_fileshare/index.rst.txt

:mod:`airflow.providers.microsoft.azure.hooks.azure_fileshare`
==============================================================

.. py:module:: airflow.providers.microsoft.azure.hooks.azure_fileshare


Module Contents
---------------

.. py:class:: AzureFileShareHook(azure_fileshare_conn_id: str = 'azure_fileshare_default')

   Bases: :class:`airflow.hooks.base.BaseHook`

   Interacts with Azure FileShare Storage.

   :param azure_fileshare_conn_id: Reference to the
       :ref:`Azure Container Volume connection id<howto/connection:azure_fileshare>`
       of an Azure account of which container volumes should be used.

   .. attribute:: conn_name_attr
      :annotation: = azure_fileshare_conn_id

      

   .. attribute:: default_conn_name
      :annotation: = azure_fileshare_default

      

   .. attribute:: conn_type
      :annotation: = azure_fileshare

      

   .. attribute:: hook_name
      :annotation: = Azure FileShare

      

   
   .. staticmethod:: get_connection_form_widgets()

      Returns connection widgets to add to connection form



   
   .. staticmethod:: get_ui_field_behaviour()

      Returns custom field behaviour



   
   .. method:: get_conn(self)

      Return the FileService object.



   
   .. method:: check_for_directory(self, share_name: str, directory_name: str, **kwargs)

      Check if a directory exists on Azure File Share.

      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.exists()` takes.
      :type kwargs: object
      :return: True if the file exists, False otherwise.
      :rtype: bool



   
   .. method:: check_for_file(self, share_name: str, directory_name: str, file_name: str, **kwargs)

      Check if a file exists on Azure File Share.

      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param file_name: Name of the file.
      :type file_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.exists()` takes.
      :type kwargs: object
      :return: True if the file exists, False otherwise.
      :rtype: bool



   
   .. method:: list_directories_and_files(self, share_name: str, directory_name: Optional[str] = None, **kwargs)

      Return the list of directories and files stored on a Azure File Share.

      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.list_directories_and_files()` takes.
      :type kwargs: object
      :return: A list of files and directories
      :rtype: list



   
   .. method:: list_files(self, share_name: str, directory_name: Optional[str] = None, **kwargs)

      Return the list of files stored on a Azure File Share.

      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.list_directories_and_files()` takes.
      :type kwargs: object
      :return: A list of files
      :rtype: list



   
   .. method:: create_share(self, share_name: str, **kwargs)

      Create new Azure File Share.

      :param share_name: Name of the share.
      :type share_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.create_share()` takes.
      :type kwargs: object
      :return: True if share is created, False if share already exists.
      :rtype: bool



   
   .. method:: delete_share(self, share_name: str, **kwargs)

      Delete existing Azure File Share.

      :param share_name: Name of the share.
      :type share_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.delete_share()` takes.
      :type kwargs: object
      :return: True if share is deleted, False if share does not exist.
      :rtype: bool



   
   .. method:: create_directory(self, share_name: str, directory_name: str, **kwargs)

      Create a new directory on a Azure File Share.

      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.create_directory()` takes.
      :type kwargs: object
      :return: A list of files and directories
      :rtype: list



   
   .. method:: get_file(self, file_path: str, share_name: str, directory_name: str, file_name: str, **kwargs)

      Download a file from Azure File Share.

      :param file_path: Where to store the file.
      :type file_path: str
      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param file_name: Name of the file.
      :type file_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.get_file_to_path()` takes.
      :type kwargs: object



   
   .. method:: get_file_to_stream(self, stream: str, share_name: str, directory_name: str, file_name: str, **kwargs)

      Download a file from Azure File Share.

      :param stream: A filehandle to store the file to.
      :type stream: file-like object
      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param file_name: Name of the file.
      :type file_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.get_file_to_stream()` takes.
      :type kwargs: object



   
   .. method:: load_file(self, file_path: str, share_name: str, directory_name: str, file_name: str, **kwargs)

      Upload a file to Azure File Share.

      :param file_path: Path to the file to load.
      :type file_path: str
      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param file_name: Name of the file.
      :type file_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.create_file_from_path()` takes.
      :type kwargs: object



   
   .. method:: load_string(self, string_data: str, share_name: str, directory_name: str, file_name: str, **kwargs)

      Upload a string to Azure File Share.

      :param string_data: String to load.
      :type string_data: str
      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param file_name: Name of the file.
      :type file_name: str
      :param kwargs: Optional keyword arguments that
          `FileService.create_file_from_text()` takes.
      :type kwargs: object



   
   .. method:: load_stream(self, stream: str, share_name: str, directory_name: str, file_name: str, count: str, **kwargs)

      Upload a stream to Azure File Share.

      :param stream: Opened file/stream to upload as the file content.
      :type stream: file-like
      :param share_name: Name of the share.
      :type share_name: str
      :param directory_name: Name of the directory.
      :type directory_name: str
      :param file_name: Name of the file.
      :type file_name: str
      :param count: Size of the stream in bytes
      :type count: int
      :param kwargs: Optional keyword arguments that
          `FileService.create_file_from_stream()` takes.
      :type kwargs: object