Azure File Service
==================

An `azure-file` location provides access over HTTPS to the
Azure File Service of an Azure Storage account.

The files stored in Azure File Service shares are accessible via the
SMB protocol and HTTP API.
Azure Files is specifically a network file system.
SFTPPlus will use the HTTPS-based API to manage the files.

..  contents:: :local:


Introduction
------------

The HTTPS connections will use the default list of `secure` ciphers and will
accept TLS v1.0, TLS v1.1 and TLS v1.2 protocols.

..  note::
    Unsecured HTTP access is not available.

..  note::
    The current implementation is tested using
    General-purpose v2 (GPv2) accounts.

Only storage account names with access keys are currently supported.
Please get in touch if you plan to use Azure Active Directory or
shared access signatures.

The path / url to the Azure File storage is case-sensitive.

When using Azure File locations, the source or destination path will be
defined as the name of the share (to or from where files are transferred)
followed by the targeted directory inside that share.
The path will look like ``/SHARE-NAME/DIR-IN-ROOT/PARENT-DIR``.

The requests made by SFTPPlus to the Azure Storage server are done using
the ``sftpplus-azure-file-UUID`` format.
Where UUID is a unique identifier for this location.
This can be used inside Azure Storage Analytics to identify the operations
done by this location.
The request ID will look like::

    x-ms-client-request-id: sftpplus-azure-file-60ec1329-cc5d-416e-81b9-7c22

.. include:: /configuration-client/locations-commons.include.rst


username
--------

:Default value: Empty
:Optional: No
:From version: 3.36.0
:Values: * Text.
:Description:
    Name of the Azure Storage Account.


password
--------

:Default value: Empty
:Optional: Yes
:From version: 3.36.0
:Values: * Plain text.
:Description:
    Any of the two access keys for the Azure storage account.

    It should be specified in Base64 format.
    This is the default format presented by the Azure Portal.
