Skip to content

Microsoft Azure Microsoft Azure: Storage - Files

Summary

This module contains actions for uploading/downloading files to/from an Azure Storage File Share.

Actions

azure.storage.files.

delete

Delete a file from an Azure Storage File Share.

The action will succeed if the file does not exist.

!!! question "Minimum Plugin Version: 3.1.0"

??? info "Input"

    - __connection_string:__ an Azure Storage Account connection string (obtained from the Azure Portal)

    - __file_share_name__: the name of the File Share in the Azure Storage Account

    - __file_path:__ the _full path_ to the target file in the File Share (including extension)

??? success "Output"

    Nothing is outputted by this action.

??? example
    ```YAML linenums="1"
    - azure.storage.files.delete:
        file_share_name: ppa-file-share
        file_path: example-file.txt
      load:
        connection_string: connection_string
    ```

azure.storage.files.

download

Download a file from an Azure Storage File Share to the task workspace.

Minimum Plugin Version: 3.1.0

Input
  • connection_string: an Azure Storage Account connection string (obtained from the Azure Portal)

  • file_share_name: the name of the File Share in the Azure Storage Account

  • source: the full path to the file in the File Share (including extension)

  • destination: the name of the file to create in the task workspace (including extension)

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
6
- azure.storage.files.download:
    file_share_name: ppa-file-share
    source: example-file.txt
    destination: example-file.txt
  load:
    connection_string: connection_string

azure.storage.files.

upload

Upload a file from the task workspace to an Azure Storage File Share.

If the target file already exists it will be overwritten.

Minimum Plugin Version: 3.1.0

Input
  • connection_string: an Azure Storage Account connection string (obtained from the Azure Portal)

  • file_share_name: the name of the File Share in the Azure Storage Account

  • source: the name of the file to upload from the task workspace (including extension)

  • destination: the full path to the file's destination in the File Share (including extension)

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
6
- azure.storage.files.upload:
    file_share_name: ppa-file-share
    source: example-file.txt
    destination: example-file.txt
  load:
    connection_string: connection_string