Azure BLOB Service¶

Introduction¶

This page is dedicated to the configuration options available for connecting to an Azure storage account.

For more information about how to implement Azure Storage (BLOB or Files) based transfers, see the separate documentation page for implementing Azure BLOB and Files transfers.

username¶

Default value:

Empty

Optional:

No

From version:

3.36.0

Values:

• Text.

Description:

Name of the Azure Storage Account.

authentication_method¶

Default value:

access-key

Optional:

Yes

Values:

• access-key

• entra-id

From version:

5.23.0

Description:

The authentication method to use for connecting to the Azure cloud.

The default value of access-key is used when authentication is done using one of the security keys defined for the storage account.

Use entra-id to authenticate using OAuth 2.0 access tokens from the Microsoft Entra.

password¶

Default value:

Empty

Optional:

Yes

From version:

3.36.0

Values:

• Plain text.

Description:

Any of the two access keys for the Azure storage account or the OAuth2 client secret.

For authentication_method = access-key, this is one of the two access keys for the Azure storage account. It should be specified in Base64 format. This is the default format presented by the Azure Portal.

For authentication_method = entra-id, this is the OAuth2 client secret and should be provided as-is, not in Base64 format.

directory_id¶

Default value:

Empty

Optional:

No

Values:

• Text

From version:

5.23.0

Description:

Directory (tenant) ID of the SFTPPlus inside the Entra ID. This value can be viewed after registering SFTPPlus in Entra ID via the App registrations page.

Only used when authentication_method = entra-id.

application_id¶

Default value:

Empty

Optional:

No

Values:

• Text

From version:

5.23.0

Description:

Application (client) ID of the SFTPPlus inside the Entra ID. This value is obtained after registering SFTPPlus in Entra ID via the App registrations page.

Only used when authentication_method = entra-id.

name¶

Default value:

Empty

Optional:

No

From version:

2.8.0

Values:

• Any text.

Description:

Human-readable short text used to identify this location.

description¶

Default value:

Empty

Optional:

Yes

From version:

2.8.0

Values:

• Any text.

Description:

Human-readable text that describes the purpose of this location.

type¶

Default value:

''

Optional:

No

From version:

2.6.0

Values:

• filesystem - Local file system.

• sftp - SFTP protocol v3 over SSH v2.

• ftp - FTP protocol without any encryption.

• ftpse - Explicit FTPS protocol.

• ftpsi - Implicit FTPS protocol.

• smb - SMB / Windows Share

• as2 - AS2 over HTTP or HTTPS

• azure-file - Azure File Service.

• azure-blob - Azure BLOB Storage.

• sharepoint-online - SharePoint via MS Graph API.

• oracle-database - Oracle Database.

• exchange-online - Microsoft Exchange Online.

• http-pull - HTTP or HTTPS for pulling files.

• smtp - SMTP protocol for sending emails.

• webdavs - WebDAV over HTTPS.

Description:

This option specifies the type of the location. Each type has a set of specific configuration options

idle_connection_timeout¶

Default value:

300

Optional:

Yes

From version:

3.0.0

Values:

• Number of seconds

• 0

Description:

This controls the automatic disconnection from the remote server after the location has not received any file transfer operation requests for the configured number of seconds.

Keep-alive command requests are not counted as file transfer operations. The connection gets automatically disconnected if keep-alive is the only command requested in the configured interval.

Disconnected locations automatically reconnect when a new file transfer operation request is made. For example, when a new file needs to be transferred to the remote server.

If the remote peer closes the connection before the configured timeout, the connection is left closed. It gets automatically reconnected when a new file transfer operation is requested.

Set to 0 to always keep the connection active, by forcing re-connection when the remote server closes the connection.

Note

The idle_connection_timeout is the maximum number of seconds before closing an idle connection to the server. If the remote server decides that the connection is idle and closes the connection, SFTPPlus doesn't try to "challenge" the server, leaving the connection closed. The connection is automatically reopened next time a file needs to be transferred.

idle_connection_keepalive_interval¶

Default value:

0

Optional:

Yes

From version:

3.0.0

Values:

• Number of seconds

Description:

Send a keep-alive command every N seconds to avoid having the connection disconnected by the other peer due to inactivity.

Set to 0 to disable keep-alive commands.

The keep-alive command does not reset the idle connection timeout,

connection_retry_count¶

Default value:

12

Optional:

Yes

From version:

3.9.0

Values:

• Number of retries

Description:

Number of times to retry connection to the location, when the initial connection fails.

Set to 0 to not retry.

When the connection still fails after all the retries, the location is marked as failed and no re-connections or transfers are attempted. An administrator needs to review the error, fix the issue, and manually restart the location.

connection_retry_interval¶

Default value:

300

Optional:

Yes

From version:

3.9.0

Values:

• Number of seconds

Description:

Number of seconds to wait between connection attempts.

Set to 0 to retry right away without any delay.