Accesses the Azure File Storage file storage service to upload, download, or delete files and folders or list file/folder information from an Azure account.
Typical Uses
- Manage datasets on File Storage by uploading, downloading, and deleting files and folders
- Transfer a file's contents (such as XML or raster) into or out of an attribute in FME
- Read downloaded File Storage data using the FeatureReader, or upload data written by the FeatureWriter to File Storage
- Retrieve file and folder names, paths, links and other information from File Storage to use elsewhere in a workspace.
How does it work?
The AzureFileStorageConnector uses your Azure Storage account credentials (either via a previously defined FME web connection, or by setting up a new FME web connection right from the transformer) to access the file storage service.
Depending on your choice of actions, it will upload or download files, folders, and attributes; list information from the service; or delete items from the service. On uploads, link attributes can be added to the output features. On List actions, file/folder information are added as attributes.
Example: Downloading a dataset
In this example, the AzureFileStorageConnector is used to download an Esri Geodatabase from File Storage. After creating a valid web connection to an Azure Storage account (which can be done right in the Account parameter), and browsing to the geodatabase folder, the Share and Path to the object is retrieved, and a destination for the download is selected.
A FeatureReader is added to read the newly downloaded dataset. Here, the PostalAddress feature type will be further processed elsewhere in the workspace.
By executing the download here in the workspace, the geodatabase will be refreshed every time the workspace is run.
Example: Downloading and using a raster as an attribute
In this example portion of a workspace, the AzureFileStorageConnector is used to download a raster orthoimage from File Storage into an attribute.
The file is read from File Storage, and the contents stored as a blob attribute. Then a RasterReplacer is used to interpret the blob into a usable raster format.
The combination of these two transformers avoids having to download the image to local storage and re-read it. A similar technique can be used for point cloud files, using the PointCloudReplacer transformer.
Usage Notes
- This transformer cannot be used to directly move or copy files between different Azure Storage locations. However, multiple AzureFileStorageConnectors can be used to move or copy files with an intermediate download.
- The FeatureReader can access Azure File Storage directly, without using the AzureFileStorageConnector. In this case, a permanent local copy of the dataset will not be created.
Configuration
Input Ports
Input
This transformer accepts any feature.
Output Ports
Output
The output of this transformer will vary depending on the action performed.
- After an Upload action, selected information about the file will be available as attributes.
- A Download action will output the incoming feature and can save to either a file, folder or attribute.
- A Delete action will output the incoming feature.
- A List action will output a new feature for each file/folder found in the path specified. Each of these new features will have attributes listing various pieces of information about the object.
Initiator
The incoming feature is output through this port.
<Rejected>
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.
Note: If a feature comes in to the AzureFileStorageConnector already having a value for fme_rejection_code, this value will be removed.
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
Authentication
| Credential Source |
The AzureFileStorageConnector can use credentials from different sources. Using a web connection integrates best with FME, but in some cases, you may wish to use one of the other sources.
|
| Account |
Available when the credential source is Web Connection. To create an Azure Storage connection, click the 'Account' drop-down box and select 'Add Web Connection...'. The connection can then be managed via Tools -> FME Options... -> Web Connections. |
| Account Name and Account Key | Available when the credential source is Embedded. An account name and access key can be specified directly in the transformer instead of in a web connection. |
| Account Name and Shared Access Signature | Available when the credential source is SAS. An account name and shared access signature can be specified directly in the transformer. |
Request
| Action |
The type of operation to perform. Choices include:
|
The remaining parameters available depend on the value of the Request > Action parameter. Parameters for each Action are detailed below.
Parameters - Delete Action
Delete Options
| Share | The share the file or folder is in. If valid credentials have been provided as a web connection, you may browse for a share. |
| Path | The full path of a file or folder on File Storage to delete. If valid credentials have been provided as a web connection, you may browse for a location. |
Parameters - Download Action
Download Options
| Share | The share the file or folder is in. If valid credentials have been provided as a web connection, you may browse for a share. |
| Path | The full path of a file or folder on File Storage to download. If valid credentials have been provided as a web connection, you may browse for a location. |
Destination
| Download as |
Select whether to store the downloaded data in a File, Folder or Attribute.
|
| Download to Attribute |
Specify the attribute that will store the contents of the downloaded file. Valid for Download as Attribute only. |
| Response Body Encoding |
For Download as Attribute, you can specify a character set encoding to ensure the output is in a human-readable form. If Auto Detect from HTTP Header is specified but there is no encoding in the Content-Type metadata associated with the data, the output will be returned as raw bytes. |
| Download to Folder | Specify the path to the folder that will store the downloaded file. Valid for Download as File or Folder. |
| If File Exists |
Specify what to do if the file already exists locally. Valid for Download as File or Folder.
|
| Include Subfolders | Choose whether to download subfolders of the File Storage source or not. Valid for Download as Folder only. |
Parameters - List Action
List Options
| Share | The share the folder is in. If valid credentials have been provided as a web connection, you may browse for a share. |
| Path | The full path to the folder on File Storage to list. If valid credentials have been provided as a web connection, you may browse for a location. |
| Include Subfolders | If set to Yes, then subfolders are recursively traversed, and their contents are included in the result. |
Output Attributes
The selected attributes will be added to the output feature.
|
_name |
Name of the file or folder |
|
_full_path |
Full path of the file or folder |
|
_url |
URL to the file or folder. |
|
_file_or_folder |
Whether the item is a file or a folder |
|
_file_size |
File size (not present for folders) |
|
_last_modified |
Date and time when the file was last modified |
|
_relative_path |
Path to the item relative to the list path |
Parameters - Upload Action
Data Source
|
Upload |
The type of data to be uploaded.
When working with large objects, File is a better choice than Attribute as the data will be streamed directly from disk and not require that the object be stored entirely in memory on a feature. When wanting to upload content from a folder, it is better to upload as a folder instead of setting a fixed path and sending multiple features into the connector to upload as a file. |
|
File to Upload |
The file to be uploaded to File Storage if Upload is set to File. |
|
Folder to Upload |
The folder to be uploaded to File Storage if Upload is set to Folder. |
|
Include Subfolders |
Choose whether to upload subfolders of the Folder to Upload or not. |
|
Attribute to Upload as File |
The data to be uploaded, supplied from an attribute if Upload is set to Attribute. |
Upload Options
| Share | The share the folder is in. If valid credentials have been provided as a web connection, you may browse for a share. |
| Path | The full path to the folder on File Storage to upload to. If valid credentials have been provided as a web connection, you may browse for a location. |
| Upload with File Name | The name of the file created from the data supplied in Attribute to Upload as File. The name must include a filename extension (for example, .txt, .jpg, .doc). |
| If File Exists |
Specify what to do if the file already exists on File Storage.
|
Metadata
It is possible to specify custom name-value pairs that are associated with the uploaded features.
Generate Shared Access Signature
If checked, a Shared Access Signature (SAS) will be generated for the uploaded file. The attributes _sas_url and _sas_token will be added to the output feature. This option is only available for file and attribute upload. For more information about SAS, please see the Microsoft Azure documentation.
| SAS Token Expiry Time |
When the token should expire. |
| IP Address or Range | If provided, restrict access to an IP address or range of IP addresses. Ranges are given in the format “203.0.113.0–203.0.113.255”. |
|
Restrict to HTTPS |
If Yes, the token can only be used via HTTPS. |
Output Attributes
The selected attributes will be added to the output feature. Only available for file and folder uploads.
| _name |
Name of the file or folder. |
| _full_path | Full path of the file or folder. |
|
_url |
URL to the file or folder. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click 
beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
How to Set Parameter Values
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more - whether entered directly in a parameter or constructed using one of the editors.
Content Types
| These functions manipulate and format strings. | |
| A set of control characters is available in the Text Editor. | |
| Math functions are available in both editors. | |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Working with User Parameters | Create your own editable parameters. |
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | Azure Storage Account |
| FME Licensing Level | FME Base Edition and above |
| Aliases | |
| History | Released FME 2019.0 |
| Categories |
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for all results about the AzureFileStorageConnector on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver