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 except the following: - Azure Government regions - Azure China 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

Operation ID:: AppendFile

This operation appends data to a file.

Required Parameters

File: string

Select a file

Key:: id

File content: binary

Content to add to the file

Key:: body

Returns

Body: BlobMetadata

Blob metadata

Copy file

Operation ID:: CopyFile

This operation copies a file to a file system.

Required Parameters

Source path: string

Path to source file

Key:: source

Destination file path: string

Destination file path, including target filename

Key:: destination

Optional Parameters

Overwrite?: boolean

Overwrites the destination file if set to 'true

Key:: overwrite

Returns

Body: BlobMetadata

Blob metadata

Create file

Operation ID:: CreateFile

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

Required Parameters

Folder path: string

Select a folder

Key:: folderPath

File name: string

Name of the file

Key:: name

File content: binary

Content of the file

Key:: body

Returns

Body: BlobMetadata

Blob metadata

Delete file

Operation ID:: DeleteFile

This operation deletes a file.

Required Parameters

File: string

Select a file

Key:: id

Returns

Body: BlobMetadata

Blob metadata

Extract archive to folder

Operation ID:: ExtractFolderV2

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

Required Parameters

Source archive file path: string

Path to the archive file

Key:: source

Destination folder path: string

Path to the destination folder

Key:: destination

Optional Parameters

Overwrite?: boolean

Overwrites the destination files if set to 'true'

Key:: overwrite

Returns

array of BlobMetadata

Get file content

Operation ID:: GetFileContent

This operation gets the content of a file.

Required Parameters

File: string

Select a file

Key:: id

Optional Parameters

Infer Content Type: boolean

Infer content-type based on extension

Key:: inferContentType

Returns

File Content: binary

The content of the file.

Get file content using path

Operation ID:: GetFileContentByPath

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

Required Parameters

File path: string

Select a file

Key:: path

Optional Parameters

Infer Content Type: boolean

Infer content-type based on extension

Key:: inferContentType

Returns

File Content: binary

The content of the file.

Get file metadata

Operation ID:: GetFileMetadata

This operation gets the metadata for a file.

Required Parameters

File: string

Select a file

Key:: id

Returns

Body: BlobMetadata

Blob metadata

Get file metadata using path

Operation ID:: GetFileMetadataByPath

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

Required Parameters

File path: string

Select a file

Key:: path

Returns

Body: BlobMetadata

Blob metadata

List files in folder

Operation ID:: ListFolder

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

Required Parameters

Folder: string

Select a folder

Key:: id

Returns

array of BlobMetadata

List files in root folder

Operation ID:: ListRootFolder

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

Required Parameters

File: string

Select a file

Key:: id

File content: binary

Content to add to the file

Key:: body

Returns

array of BlobMetadata

Rename File

Operation ID:: RenameFile

This operation renames a file.

Required Parameters

File: string

Select a file

Key:: id

New name: string

New name for the file

Key:: newName

Returns

Body: BlobMetadataResponse

Represents blob datasets metadata response

Update file

Operation ID:: UpdateFile

This operation updates a file.

Required Parameters

File: string

Select a file

Key:: id

File content: binary

Content of the file

Key:: body

Returns

Body: BlobMetadata

Blob metadata

Triggers

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.

Required Parameters

Folder: string

Select a folder

Key:: folderId

Optional Parameters

Number of files: integer

Max file count (1-100)

Key:: maxFileCount

Returns

List of Files: BlobMetadata

Blob metadata

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.

Required Parameters

Folder: string

Select a folder

Key:: folderId

Optional Parameters

Number of files: integer

Max file count (1-100)

Key:: maxFileCount

Returns

List of Files: BlobMetadata

Blob metadata

Definitions

BlobMetadata

Blob metadata

DisplayName: string

The display name of the file or folder.

Path:: DisplayName

ETag: string

The etag of the file or folder.

Path:: ETag

FileLocator: string

The filelocator of the file or folder.

Path:: FileLocator

Id: string

The unique id of the file or folder.

Path:: Id

IsFolder: boolean

A boolean value (true, false) to indicate whether or not the blob is a folder.

Path:: IsFolder

LastModified: date-time

The date and time the file or folder was last modified.

Path:: LastModified

MediaType: string

The media type of the file or folder.

Path:: MediaType

Name: string

The name of the file or folder.

Path:: Name

Path: string

The path of the file or folder.

Path:: Path

Size: integer

The size of the file or folder.

Path:: Size

BlobMetadataResponse

Represents blob datasets metadata response

DisplayName: string

The display name of the file or folder.

Path:: DisplayName

ETag: string

The etag of the file or folder.

Path:: ETag

FileLocator: string

The filelocator of the file or folder.

Path:: FileLocator

Id: string

The unique id of the file or folder.

Path:: Id

IsFolder: boolean

A boolean value (true, false) to indicate whether or not the blob is a folder.

Path:: IsFolder

LastModified: date-time

The date and time the file or folder was last modified.

Path:: LastModified

MediaType: string

The media type of the file or folder.

Path:: MediaType

Name: string

The name of the file or folder.

Path:: Name

Path: string

The path of the file or folder.

Path:: Path

Size: integer

The size of the file or folder.

Path:: Size