< Back to Top

Azure Blob Endpoint

The Azure Blob Endpoint has the following attributes:

Attribute Description
Storage Account The Azure Storage account name.
Authentication

Two methods of authentication are available - Access Key and Azure Key Vault.

Choose a method from the drop down menu to reveal fields appropriate for your choice.

Access Key
Access Key Specify the Access Key to use to authenticate for this Endpoint.
Azure Key Vault

To use Azure Key Vault authentication, you need an Azure Key Vault with a secret that contains the access key and an application service principal that has access to the Key Vault. You provide values for these items in the fields below.

Key Vault Name The Azure Key Vault name.
Key Vault Secret Name The name of the secret in the Azure Key Vault.
Application Client ID The ID of the client registered as an application in Azure Active Directory. Used to authenticate to Azure Key Vault.
Application Client Secret The secret for the client registered as an application in Azure Active Directory. Used to authenticate to Azure Key Vault.
Container

The Azure Storage container name. Valid pattern:

[^[a-z0-9]{1}[a-z0-9-]{1,62}]
Blob Type The Azure Blob Storage blob type. This setting controls the blob type for created blobs. Default is Block Blob
Advanced - Connection
Endpoint Suffix The Azure Storage endpoint suffix. Default is "core.windows.net" Specify the endpoint suffix to use in the connection string.
Headers A editable list of optional additional HTTP headers. See Editing Headers.
Retrieve Directory Sort

Specify the sorting order for files being transferred and processed. Choose from the following:

  • None  (Default value)
  • Alphabetical (ascending)
  • Alphabetical (descending)
  • Date/Time Modified (ascending)
  • Date/Time Modified (descending)
  • Size (ascending)
  • Size (descending)
Maximum Directory Entries Returned

Specify the maximum number of directory entries to return and display. 

Note: Use this property with caution when this Endpoint is being used as a linked folder for a Partner Mailbox. 

  • Specifying a value that is too small might not show all the files actually in the directory when browsing the Endpoint or when browsing the Endpoint in a Data Flow. In addition, jobs might not include all of the available files.
  • Specifying a value that is too large might cause timeouts because of the large number of directory entries.

Minimum value: 0 (no limit)
Maximum value: 2147483647
Default value: 1500
Automatic Retries

The number of retries that should be made during an attempt. An attempt consists of the number of transfer retries you specify. For example, if you specify 5 retries and 30 seconds, an attempt would consist of 5 retries occurring in the span of 30 seconds.

This setting applies to both sends and receives. 

The minimum number of retries is 0 and the maximum is 5.

The time between retries can range from 0 to 120 seconds.

See Retrying Failed File Transfer Attempts.
Extended Outbound Retries

The period of time during which outbound retries are attempted after a failed send attempt and subsequent failed automatic retry. Retries will not be attempted after the end of the period specified.

This period starts when the first retry is attempted and ends after the value you specify elapses.

Minimum value is 15 minutes.

Maximum value is 3 days.

See Retrying Failed File Transfer Attempts.
Concurrent Outbound Transfers Specify the maximum number of connections that can be transferring to this Endpoint at the same time. Minimum value is 1 and maximum is 10.
Events

CIC allows you to send notification email to one or more recipients upon successful Send to or Receive from this Endpoint.  Use the Upon successful Send to this Endpoint... and Upon successful Receive from this Endpoint... fields to specify the recipients.

Recipients can be CIC users or external recipients. CIC users receive more detailed emails and benefit from a type-ahead dropdown when entering names, while external recipients get a simpler email and require full email addresses to be entered manually.

For all recipients, the notification email includes a link where the recipient can opt out of notifications from this Endpoint or all Endpoints. If a recipient opts out of these notifications, their email address no longer appears in the list of recipients you specified.
Advanced - Logging
Enable Debug Select to enable debug-level logging for this endpoint.
Linked Folders If this Endpoint is linked as a folder in one or more Partner Mailboxes, this list displays the names of those Partner Mailboxes and folders.

Editing Headers

When you click the Headers > Edit button, the Headers dialog box displays.

To add a header, enter a header name and value, and then click Add.

To disable a header, clear the Enabled check box for that row.

AzureBlob Endpoint Commands

The following commands are available for AzureBlob Endpoints.

CLEAR

Clear a property string value. The cleared value only affects the commands that follow the CLEAR.

CLEAR property
property Property name with no embedded spaces.

DIR

Get a directory listing of available files from the host

DIR "source"
source Remote source directory path.

GET

Receive one or more files from the host

GET -REC –DEL "source" "destination"
-REC

Recursively retrieve nested subdirectories.

If used in conjunction with –DEL, the retrieved files, but not subdirectories, are deleted on the server.

Optional.
-DEL

If the GET is successful, delete the remote file.

Optional.
source

Remote source path. You can specify a path (folder/) or a path+filter (folder/*.txt)

If the path contains a macro variable, space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination

CIC destination path.

  • Path can be to a filename or to a directory.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PUT

Send one or more files to the host.

PUT "source" "destination"
source
  • Source is a filename.
  • You can use * and ?, or a regular expression when you specify a filename.
  • See Using Wildcards and Regular Expressions in CIC for additional information.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the source contains a macro variable, space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination Remote destination filename. If the destination contains a macro variable, space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("..."). The use of macro variables is supported. See Using Macro Variables in CIC (Destination context) for a list of the applicable macros. 

SET

Change a property value. The new value only affects the commands that follow the SET.

SET property=value
property = value

Property and new value

  • The property name must have no embedded spaces.
  • The value specified remains in effect until it is set again or until the end of the dataflow.  

  • To reset the property back to default value, specify
    SET property
    or

    SET property=

Valid properties for SET command are as follows:

RetrieveDirectorySort

Use this property to control the order in which files are downloaded from the server. Possible values include:

  • Alphabetical (ascending)
  • Alphabetical (descending)
  • Date/Time Modified (ascending)
  • Date/Time Modified (descending)
  • Size (ascending)
  • Size (descending)
TerminateOnFail

Valid for all Endpoints configured as source in a Data Flow.
Use this property to control command processing when errors occur.
Possible values:

  • True - Command processing stops when an error occurs.
  • False - Command processing continues even when an error occurs.

Default value is True.

WAIT

Pause execution.

WAIT seconds
seconds Number of seconds to pause.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.