===========
Azure Files
===========

Waarp Transfer permet d'utiliser un share Azure Files à la place du disque dur local.

.. note::
   Ne pas confondre avec :doc:`Azure Blob<azureblob>`.

Configuration
-------------

Pour utiliser une instance cloud, celle-ci doit d'abord être créée et configurée.
Pour créer une instance cloud Azure Files, le type renseigné doit être ``azfiles``
ou ``azurefiles``.

Authentification
^^^^^^^^^^^^^^^^

Pour se connecter à une instance Azure, Waarp Transfer a besoin d'identifiants.
Ces identifiants peuvent être fournis de 2 manières différentes :

- Soit en les renseignant directement à la création de l'instance cloud, auquel cas :

  - Le paramètre *key* doit contenir le nom de compte
  - Le paramètre *secret* doit contenir la clé du compte
- Soit en les renseignant dans des variables d'environnement. Les variables
  suivantes doivent être renseignées :

  - :envvar:`AZURE_STORAGE_ACCOUNT` pour le nom de compte
  - :envvar:`AZURE_CLIENT_SECRET` pour la clé d'authentification
  - :envvar:`AZURE_TENANT_ID` pour l'ID du locataire Microsoft Entra
  - :envvar:`AZURE_CLIENT_ID` pour l'ID de l'application

Options
^^^^^^^

Les options de configuration suivantes sont disponibles pour Azure Files :

* **share_name**: *REQUIS* - Le nom du *share* dans lequel le fichier sera déposé.
* **endpoint**: L'adresse du serveur Azure (si celle-ci est différente de l'adresse
  par défaut ``core.windows.net``).
* **env_auth**: Booléen, mettre à ``true`` pour activer l'authentification via
  variables d'environnement décrite ci-dessus.

Exemple
-------

Prenons le cas de figure suivant :

- fichier: ``doc/waarp-transfer.pdf``
- share: ``archive``
- nom de compte: ``toto``
- clé d'accès: ``sesame``

Dans un premier temps, l'instance cloud doit être définie. Dans cet exemple, nous
lui donnerons le nom "ex-azfiles".

La commande de création pour cette instance cloud est donc :

.. code-block:: shell

   waarp-transfer cloud add -n "ex-azfiles" -t "azblob" -k "toto" -s "sesame" -o "share_name:archive"

Par la suite, lors de mon transfert, le chemin du fichier devra donc ressembler à :

| ex-azfiles:doc/waarp-transfer.pdf