Transloadit

Import files from Azure

🤖/azure/import imports whole directories of files from your Azure container.

Usage example

Import files from the path/to/files directory and its subdirectories:

{
  "steps": {
    "imported": {
      "robot": "/azure/import",
      "credentials": "YOUR_AZURE_CREDENTIALS",
      "path": "path/to/files/"
    }
  }
}

Parameters

  • output_meta

    Record<string, boolean> | boolean | Array<string>

    Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.

    For images, you can add "has_transparency": true in this object to extract if the image contains transparent parts and "dominant_colors": true to extract an array of hexadecimal color codes from the image.

    For videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.

    For audio, you can add "mean_volume": true to get a single value representing the mean average volume of the audio file.

    You can also set this to false to skip metadata extraction and speed up transcoding.

  • result

    boolean (default: false)

    Whether the results of this Step should be present in the Assembly Status JSON

  • queue

    batch

    Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times

  • force_accept

    boolean (default: false)

    Force a Robot to accept a file type it would have ignored.

    By default, Robots ignore files they are not familiar with. 🤖/video/encode, for example, will happily ignore input images.

    With the force_accept parameter set to true, you can force Robots to accept all files thrown at them. This will typically lead to errors and should only be used for debugging or combatting edge cases.

  • force_name

    string | Array<string> | null (default: null)

    Custom name for the imported file(s). By default file names are derived from the source.

  • credentials

    string

    Please create your associated Template Credentials in your Transloadit account and use the name of your Template Credentials as this parameter's value. They will contain the values for your Azure Container, Account and Key.

    While we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead: "account", "key", "container".

  • path — required

    string | Array<string>

    The path in your container to the specific file or directory. If the path points to a file, only this file will be imported. For example: images/avatar.jpg.

    If it points to a directory, indicated by a trailing slash (/), then all files that are descendants of this directory are recursively imported. For example: images/.

    If you want to import all files from the root directory, please use / as the value here.

    You can also use an array of path strings here to import multiple paths in the same Robot's Step.

  • recursive

    boolean (default: false)

    Setting this to true will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.

  • next_page_token

    string (default: "")

    A string token used for pagination. The returned files of one paginated call have the next page token inside of their meta data, which needs to be used for the subsequent paging call.

  • files_per_page

    string | number (default: 1000)

    The pagination page size.

Related blog posts