File System

File System

Connect to File Systems on your local or network machines to read from and write to files using the On-Premises Data Gateway.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

General Limits

Name Value
Maximum file size for general operations (in MB) 30
Maximum file size for create file operation (in MB) 20
On-premises data gateway connection timeout (in seconds) 30

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

Root folder
string
Root folder path (examples: \\MACHINE\myShare or C:\myShare)
Authentication Type
string
Authentication type to connect to your gateway computer
Username
securestring
Username credential (e.g. DOMAIN\Username)
Password
securestring
Password credential
Gateway
gatewaySetting

Actions

Append file

This operation appends data to a file.

Required Parameters

File
string
Select a file
File content
binary
Content to add to the file

Returns

Body
BlobMetadata

Blob metadata

Copy file

This operation copies a file to a file system.

Required Parameters

Source path
string
Path to source file
Destination file path
string
Destination file path, including target filename

Optional Parameters

Overwrite?
boolean
Overwrites the destination file if set to 'true

Returns

Body
BlobMetadata

Blob metadata

Create file

This operation creates a file. If the file already exists, the existing content is replaced.

Required Parameters

Folder path
string
Select a folder
File name
string
Name of the file
File content
binary
Content of the file

Returns

Body
BlobMetadata

Blob metadata

Delete file

This operation deletes a file.

Required Parameters

File
string
Select a file

Returns

Body
BlobMetadata

Blob metadata

Extract archive to folder

This operation extracts an archive file into a folder (example: .zip).

Required Parameters

Source archive file path
string
Path to the archive file
Destination folder path
string
Path to the destination folder

Optional Parameters

Overwrite?
boolean
Overwrites the destination files if set to 'true'

Returns

array of BlobMetadata

Get file content

This operation gets the content of a file.

Required Parameters

File
string
Select a file

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension

Returns

File Content
binary

The content of the file.

Get file content using path

This operation gets the content of a file using the path.

Required Parameters

File path
string
Select a file

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension

Returns

File Content
binary

The content of the file.

Get file metadata

This operation gets the metadata for a file.

Required Parameters

File
string
Select a file

Returns

Body
BlobMetadata

Blob metadata

Get file metadata using path

This operation gets the metadata of a file using the path.

Required Parameters

File path
string
Select a file

Returns

Body
BlobMetadata

Blob metadata

List files in folder

This operation gets the list of files and subfolders in a folder.

Required Parameters

Folder
string
Select a folder

Returns

array of BlobMetadata

List files in root folder

This operation gets the list of files and subfolders in the root folder.

Required Parameters

File
string
Select a file
File content
binary
Content to add to the file

Returns

array of BlobMetadata

Rename File

This operation renames a file.

Required Parameters

File
string
Select a file
New name
string
New name for the file

Returns

Body
BlobMetadataResponse

Represents blob datasets metadata response

Update file

This operation updates a file.

Required Parameters

File
string
Select a file
File content
binary
Content of the file

Returns

Body
BlobMetadata

Blob metadata

Triggers

When a file is added or modified (properties only)

This operation triggers a flow when one or more files are added or modified in a folder.

Required Parameters

Folder
string
Select a folder

Optional Parameters

Number of files
integer
Max file count (1-100)

Returns

List of Files
BlobMetadata

Blob metadata

When a file is created (properties only)

This operation triggers a flow when one or more files are created in a folder.

Required Parameters

Folder
string
Select a folder

Optional Parameters

Number of files
integer
Max file count (1-100)

Returns

List of Files
BlobMetadata

Blob metadata

Definitions

BlobMetadata

Blob metadata

DisplayName
string
The display name of the file or folder.
ETag
string
The etag of the file or folder.
FileLocator
string
The filelocator of the file or folder.
Id
string
The unique id of the file or folder.
IsFolder
boolean
A boolean value (true, false) to indicate whether or not the blob is a folder.
LastModified
date-time
The date and time the file or folder was last modified.
MediaType
string
The media type of the file or folder.
Name
string
The name of the file or folder.
Path
string
The path of the file or folder.
Size
integer
The size of the file or folder.

BlobMetadataResponse

Represents blob datasets metadata response

DisplayName
string
The display name of the file or folder.
ETag
string
The etag of the file or folder.
FileLocator
string
The filelocator of the file or folder.
Id
string
The unique id of the file or folder.
IsFolder
boolean
A boolean value (true, false) to indicate whether or not the blob is a folder.
LastModified
date-time
The date and time the file or folder was last modified.
MediaType
string
The media type of the file or folder.
Name
string
The name of the file or folder.
Path
string
The path of the file or folder.
Size
integer
The size of the file or folder.