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

Creating a connection

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

Name	Type	Description
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

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Append file	This operation appends data to a file.
Copy file	This operation copies a file to a file system.
Create file	This operation creates a file. If the file already exists, the existing content is replaced.
Delete file	This operation deletes a file.
Extract archive to folder	This operation extracts an archive file into a folder (example: .zip).
Get file content	This operation gets the content of a file.
Get file content using path	This operation gets the content of a file using the path.
Get file metadata	This operation gets the metadata for a file.
Get file metadata using path	This operation gets the metadata of a file using the path.
List files in folder	This operation gets the list of files and subfolders in a folder.
List files in root folder	This operation gets the list of files and subfolders in the root folder.
Rename File	This operation renames a file.
Update file	This operation updates a file.

Append file

Operation ID:: AppendFile

This operation appends data to a file.

Parameters

Name	Key	Required	Type	Description
File	id	True	string	Select a file
File content	body	True	binary	Content to add to the file

Returns

Blob metadata

Body: BlobMetadata

Copy file

Operation ID:: CopyFile

This operation copies a file to a file system.

Parameters

Name	Key	Required	Type	Description
Source path	source	True	string	Path to source file
Destination file path	destination	True	string	Destination file path, including target filename
Overwrite?	overwrite		boolean	Overwrites the destination file if set to 'true

Returns

Blob metadata

Body: BlobMetadata

Create file

Operation ID:: CreateFile

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

Parameters

Name	Key	Required	Type	Description
Folder path	folderPath	True	string	Select a folder
File name	name	True	string	Name of the file
File content	body	True	binary	Content of the file

Returns

Blob metadata

Body: BlobMetadata

Delete file

Operation ID:: DeleteFile

This operation deletes a file.

Parameters

Name	Key	Required	Type	Description
File	id	True	string	Select a file

Extract archive to folder

Operation ID:: ExtractFolderV2

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

Parameters

Name	Key	Required	Type	Description
Source archive file path	source	True	string	Path to the archive file
Destination folder path	destination	True	string	Path to the destination folder
Overwrite?	overwrite		boolean	Overwrites the destination files if set to 'true'

Returns

response: array of BlobMetadata

Get file content

Operation ID:: GetFileContent

This operation gets the content of a file.

Parameters

Name	Key	Required	Type	Description
File	id	True	string	Select a file
Infer Content Type	inferContentType		boolean	Infer content-type based on extension

Returns

The content of the file.

File Content: binary

Get file content using path

Operation ID:: GetFileContentByPath

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

Parameters

Name	Key	Required	Type	Description
File path	path	True	string	Select a file
Infer Content Type	inferContentType		boolean	Infer content-type based on extension

Returns

The content of the file.

File Content: binary

Get file metadata

Operation ID:: GetFileMetadata

This operation gets the metadata for a file.

Parameters

Name	Key	Required	Type	Description
File	id	True	string	Select a file

Returns

Blob metadata

Body: BlobMetadata

Get file metadata using path

Operation ID:: GetFileMetadataByPath

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

Parameters

Name	Key	Required	Type	Description
File path	path	True	string	Select a file

Returns

Blob metadata

Body: BlobMetadata

List files in folder

Operation ID:: ListFolder

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

Parameters

Name	Key	Required	Type	Description
Folder	id	True	string	Select a folder

Returns

response: array of BlobMetadata

List files in root folder

Operation ID:: ListRootFolder

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

Returns

response: array of BlobMetadata

Rename File

Operation ID:: RenameFile

This operation renames a file.

Parameters

Name	Key	Required	Type	Description
File	id	True	string	Select a file
New name	newName	True	string	New name for the file

Returns

Represents blob datasets metadata response

Body: BlobMetadataResponse

Update file

Operation ID:: UpdateFile

This operation updates a file.

Parameters

Name	Key	Required	Type	Description
File	id	True	string	Select a file
File content	body	True	binary	Content of the file

Returns

Blob metadata

Body: BlobMetadata

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.
When a file is created (properties only)	This operation triggers a flow when one or more files are created in a folder.

When a file is added or modified (properties only)

Operation ID:: OnUpdatedFiles

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

Parameters

Name	Key	Required	Type	Description
Folder	folderId	True	string	Select a folder
Number of files	maxFileCount		integer	Max file count (1-100)

Returns

Blob metadata

List of Files: BlobMetadata

When a file is created (properties only)

Operation ID:: OnNewFiles

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

Parameters

Name	Key	Required	Type	Description
Folder	folderId	True	string	Select a folder
Number of files	maxFileCount		integer	Max file count (1-100)

Returns

Blob metadata

List of Files: BlobMetadata

Definitions

BlobMetadata

Blob metadata

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

BlobMetadataResponse

Represents blob datasets metadata response

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