Connectors Reference
Microsoft Azure Storage provides a massively scalable, durable, and highly available storage for data on the cloud, and serves as the data storage solution for modern applications. Connect to Blob Storage to perform various operations such as create, update, get and delete on blobs in your Azure Storage account.
|
Status: Production |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
CreateShareLinkByPath (string path, SharedAccessSignatureBlobPolicy policy) |
Create SAS URI by path |
|
Set blob tier by path |
|
|
Get available access policies |
|
|
Create block blob |
|
|
|
|
|
Create blob |
|
|
Get Blob Metadata |
|
|
UpdateFile (string id, string body, [advanced][Optional]string Content-Type) |
Update blob |
|
Delete blob |
|
|
Append blob |
|
|
GetFileMetadataByPath (string path, [internal][Optional]boolean queryParametersSingleEncoded) |
Get Blob Metadata using path |
|
Get blob content using path |
|
|
GetFileContent (string id, [advanced][Optional]boolean inferContentType) |
Get blob content |
|
|
|
|
Copy blob |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CreateFile_Old (string folderPath, string name, string body) |
|
|
CopyFile_Old (string source, string destination, [Optional]boolean overwrite) |
|
|
|
|
|
List blobs in container |
|
|
List blobs |
|
|
List blobs in root folder |
|
|
|
|
|
List blobs in root folder |
|
|
|
|
|
ListAllRootFoldersV2 ([internal][Optional]string nextPageMarker) |
|
|
Extract archive to folder |
|
|
|
|
|
|
|
|
ExtractFolder_Old (string source, string destination, [Optional]boolean overwrite) |
|
|
Name |
Summary |
|
When a blob is added |
|
|
When a blob is added or modified |
|
|
OnNewFiles (string folderId, [advanced][Optional]integer maxFileCount) |
|
|
When a blob is added or modified (properties only) |
|
|
|
|
|
|
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Create SAS URI by path
Description: This operation creates a SAS link for a blob using the path.
Syntax:
AzureBlobStorage.CreateShareLinkByPath (string path, SharedAccessSignatureBlobPolicy policy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
path |
string (Blob path) |
The unique path of the blob. |
True |
|
|
policy |
SharedAccessSignatureBlobPolicy
|
The set of parameters to generate a SAS link. |
True |
Returns:
Description: Shared access signature
Summary: Set blob tier by path
Description: This operation sets a tier for a block blob on a standard storage account using the path.
Syntax:
AzureBlobStorage.SetBlobTierByPath (string path, string newTier)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
path |
string (Blob path) |
The unique path of the blob. |
True |
|
|
newTier |
string (Blob Tier)Values: [Hot, Cool, Archive] |
The new tier for the blob. |
True |
Returns:
Summary: Get available access policies
Description: This operation gets available shared access policies for a blob.
Syntax:
AzureBlobStorage.GetAccessPolicies (string path)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
path |
string (Blob path) |
The unique path of the blob. |
True |
Returns:
Type:array of (SharedAccessSignatureBlobPolicy)
Summary: Create block blob
Description: This operation uploads a block blob to Azure Blob Storage.
Syntax:
AzureBlobStorage.CreateBlockBlob (string folderPath, string name, string body, [advanced][Optional]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Specify folder path to upload) |
Specify folder path to upload. |
True |
|
|
name |
string (Specify name of the blob to create) |
Specify name of the blob to create. |
True |
|
|
body |
string(binary)
|
|
True |
|
|
Content-Type |
string (Content-Type) |
Specify content-type of the blob to upload. |
False |
Returns:
Summary:
Description:
Syntax:
AzureBlobStorage.TestConnection ()
Returns:
Summary: Create blob
Description: This operation uploads a blob to Azure Blob Storage.
Syntax:
AzureBlobStorage.CreateFile (string folderPath, string name, string body, [internal][Optional]boolean queryParametersSingleEncoded, [advanced][Optional]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string (Folder path) |
Specify folder path to upload |
True |
|
|
name |
string (Blob name) |
Specify name of the blob to create |
True |
|
|
body |
string(binary)
|
|
True |
|
|
queryParametersSingleEncoded |
boolean
|
|
False |
|
|
Content-Type |
string (Content-Type) |
Specify content-type of the blob to upload. |
False |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary: Get Blob Metadata
Description: This operation retrieves blob metadata using blob id.
Syntax:
AzureBlobStorage.GetFileMetadata (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Blob) |
Specify the blob |
True |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary: Update blob
Description: This operation updates a blob in Azure Blob Storage.
Syntax:
AzureBlobStorage.UpdateFile (string id, string body, [advanced][Optional]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Blob) |
Specify the blob to update |
True |
|
|
body |
string(binary)
|
|
True |
|
|
Content-Type |
string (Content-Type) |
Specify content-type of the blob to update. |
False |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary: Delete blob
Description: This operation deletes a blob.
Syntax:
AzureBlobStorage.DeleteFile (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Blob) |
Specify the blob to delete |
True |
Returns:
Summary: Append blob
Description: This operation appends to a blob.
Syntax:
AzureBlobStorage.AppendFile (string id, string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Blob) |
Specify the blob to append to |
True |
|
|
body |
string(binary)
|
|
True |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary: Get Blob Metadata using path
Description: This operation retrieves blob metadata using path.
Syntax:
AzureBlobStorage.GetFileMetadataByPath (string path, [internal][Optional]boolean queryParametersSingleEncoded)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
path |
string (Blob path) |
Specify unique path to the blob |
True |
|
|
queryParametersSingleEncoded |
boolean
|
|
False |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary: Get blob content using path
Description: This operation retrieves blob contents using path
Syntax:
AzureBlobStorage.GetFileContentByPath (string path, [advanced][Optional]boolean inferContentType, [internal][Optional]boolean queryParametersSingleEncoded)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
path |
string (Blob path) |
Specify unique path to the blob |
True |
|
|
inferContentType |
boolean (Infer Content Type) |
Infer content-type based on extension |
False |
|
|
queryParametersSingleEncoded |
boolean
|
|
False |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Get blob content
Description: This operation retrieves blob contents using id.
Syntax:
AzureBlobStorage.GetFileContent (string id, [advanced][Optional]boolean inferContentType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Blob) |
Specify the blob |
True |
|
|
inferContentType |
boolean (Infer Content Type) |
Infer content-type based on extension |
False |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary:
Description:
Syntax:
AzureBlobStorage.RenameFile (string id, string newName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
|
|
newName |
string
|
|
True |
Returns:
Type:BlobMetadataResponse
Description: Represents blob datasets metadata response
Summary: Copy blob
Description: This operation copies a blob. If blob is being deleted/renamed on server right after it was copied, connector may return HTTP 404 error by it's design. Please use a delay for 1 minute before deleting or renaming newly created blob. Chunk transfer is not supported in this action. If source and destination are present in same storage account, please use relative path. Otherwise, maximum size of a source for copy blob operation is 50 MB.
Syntax:
AzureBlobStorage.CopyFile (string source, string destination, [Optional]boolean overwrite, [internal][Optional]boolean queryParametersSingleEncoded)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
source |
string (Source url) |
Specify the Url to source blob |
True |
|
|
destination |
string (Destination blob path) |
Specify the destination blob path, including target blobname |
True |
|
|
overwrite |
boolean (Overwrite?) |
Should the destination blob be overwritten (true/false)? |
False |
|
|
queryParametersSingleEncoded |
boolean
|
|
False |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary:
Description:
Syntax:
AzureBlobStorage.GetFileMetadata_Old (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary:
Description:
Syntax:
AzureBlobStorage.UpdateFile_Old (string id, string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
|
|
body |
string(binary)
|
|
True |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary:
Description:
Syntax:
AzureBlobStorage.DeleteFile_Old (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
Returns:
Summary:
Description:
Syntax:
AzureBlobStorage.GetFileMetadataByPath_Old (string path)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
path |
string
|
|
True |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary:
Description:
Syntax:
AzureBlobStorage.GetFileContentByPath_Old (string path)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
path |
string
|
|
True |
Returns:
Type:string(binary)
Summary:
Description:
Syntax:
AzureBlobStorage.GetFileContent_Old (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
Returns:
Type:string(binary)
Summary:
Description:
Syntax:
AzureBlobStorage.CreateFile_Old (string folderPath, string name, string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string
|
|
True |
|
|
name |
string
|
|
True |
|
|
body |
string(binary)
|
|
True |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary:
Description:
Syntax:
AzureBlobStorage.CopyFile_Old (string source, string destination, [Optional]boolean overwrite)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
source |
string
|
|
True |
|
|
destination |
string
|
|
True |
|
|
overwrite |
boolean
|
|
False |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary:
Description:
Syntax:
AzureBlobStorage.GetDataSetsMetadata ()
Returns:
Type:DataSetsMetadata
Description: Dataset metadata
Summary: List blobs in container
Description: This operation lists blobs in a container.
Syntax:
AzureBlobStorage.ListFolder (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Folder) |
Specify the folder |
True |
Returns:
Type:array of (BlobMetadata)
Summary: List blobs
Description: This operation lists blobs in a container.
Syntax:
AzureBlobStorage.ListFolderV2 (string id, [advanced][Optional]string nextPageMarker, [advanced][Optional]boolean useFlatListing)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Folder) |
Specify the folder |
True |
|
|
nextPageMarker |
string (Paging Marker) |
A marker that identifies the portion of the list to be returned with the list operation |
False |
|
|
useFlatListing |
boolean (Flat Listing) |
Whether or not to list blobs in flat listing |
False |
Returns:
Type:BlobMetadataPage
Description: Represents a page of blob metadata.
Summary: List blobs in root folder
Description: This operation lists blobs in the Azure Blob Storage root folder.
Syntax:
AzureBlobStorage.ListRootFolder ()
Returns:
Type:array of (BlobMetadata)
Summary:
Description:
Syntax:
AzureBlobStorage.CreateFolder (string folderPath, string name)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderPath |
string
|
|
True |
|
|
name |
string
|
|
True |
Returns:
Type:BlobMetadata
Description: Blob metadata
Summary: List blobs in root folder
Description: This operation lists blobs in the Azure Blob Storage root folder.
Syntax:
AzureBlobStorage.ListRootFolderV2 ([advanced][Optional]string nextPageMarker, [internal][Optional]boolean useFlatListing)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
nextPageMarker |
string (Paging Marker) |
A marker that identifies the portion of the list to be returned with the list operation |
False |
|
|
useFlatListing |
boolean (Flat Listing) |
|
False |
Returns:
Type:BlobMetadataPage
Description: Represents a page of blob metadata.
Summary:
Description:
Syntax:
AzureBlobStorage.ListAllRootFolders ()
Returns:
Type:array of (BlobMetadata)
Summary:
Description:
Syntax:
AzureBlobStorage.ListAllRootFoldersV2 ([internal][Optional]string nextPageMarker)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
nextPageMarker |
string (Paging Marker) |
|
False |
Returns:
Type:BlobMetadataPage
Description: Represents a page of blob metadata.
Summary: Extract archive to folder
Description: This operation extracts an archive blob into a folder (example: .zip).
Syntax:
AzureBlobStorage.ExtractFolderV2 (string source, string destination, [Optional]boolean overwrite, [internal][Optional]boolean queryParametersSingleEncoded)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
source |
string (Source archive blob path) |
Specify the path to the archive blob |
True |
|
|
destination |
string (Destination folder path) |
Specify the path in Azure Blob Storage to extract the archive contents |
True |
|
|
overwrite |
boolean (Overwrite?) |
Should destination blob be overwritten (true/false)? |
False |
|
|
queryParametersSingleEncoded |
boolean
|
|
False |
Returns:
Type:array of (BlobMetadata)
Summary:
Description:
Syntax:
AzureBlobStorage.ListFolder_Old (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string
|
|
True |
Returns:
Type:array of (BlobMetadata)
Summary:
Description:
Syntax:
AzureBlobStorage.ListRootFolder_Old ()
Returns:
Type:array of (BlobMetadata)
Summary:
Description:
Syntax:
AzureBlobStorage.ExtractFolder_Old (string source, string destination, [Optional]boolean overwrite)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
source |
string
|
|
True |
|
|
destination |
string
|
|
True |
|
|
overwrite |
boolean
|
|
False |
Returns:
Summary: When a blob is added
Description: This operation triggers a flow when a blob is added in a container. The trigger will fetch both the file metadata as well as the content of the file. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.
Syntax:
AzureBlobStorage.OnNewFile (string folderId, [advanced][Optional]boolean inferContentType, [internal][Optional]boolean queryParametersSingleEncoded)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderId |
string (Container) |
Select a container |
True |
|
|
inferContentType |
boolean (Infer Content Type) |
Infer content-type based on extension |
False |
|
|
queryParametersSingleEncoded |
boolean
|
|
False |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: When a blob is added or modified
Description: This operation triggers a flow when a blob is added or modified in a container. The trigger will fetch both the file metadata as well as the content of the file. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.
Syntax:
AzureBlobStorage.OnUpdatedFile (string folderId, [internal][Optional]boolean includeFileContent, [advanced][Optional]boolean inferContentType, [internal][Optional]boolean queryParametersSingleEncoded)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderId |
string (Container) |
Select a container |
True |
|
|
includeFileContent |
boolean (Include file content) |
If set to true, file content will also be retrieved along with the trigger response |
False |
|
|
inferContentType |
boolean (Infer Content Type) |
Infer content-type based on extension |
False |
|
|
queryParametersSingleEncoded |
boolean
|
|
False |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary:
Description:
Syntax:
AzureBlobStorage.OnNewFiles (string folderId, [advanced][Optional]integer maxFileCount)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderId |
string
|
|
True |
|
|
maxFileCount |
integer(int32) (Number of files to return from the trigger) |
|
False |
Returns:
Type:array of (BlobMetadata)
Summary: List of Files
Summary: When a blob is added or modified (properties only)
Description: This operation triggers a flow when one or more blobs are added or modified in a container. This trigger will only fetch the file metadata. To get the file content, you can use the "Get file content" operation. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.
Syntax:
AzureBlobStorage.OnUpdatedFiles (string folderId, [advanced][Optional]integer maxFileCount, [internal][Optional]boolean checkBothCreatedAndModifiedDateTime)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderId |
string (Container) |
Select a container |
True |
|
|
maxFileCount |
integer(int32) (Number of blobs to return from the trigger) |
Max blob count (1-100) |
False |
|
|
checkBothCreatedAndModifiedDateTime |
boolean (Check Both File's Created DateTime And Last Modified DateTime) |
If the flag is set to true, the trigger will check the file's created date and time and the file's last modified date and time. If the flag is set to false, the trigger will only check the file's last modified date and time. |
False |
Returns:
Type:array of (BlobMetadata)
Summary: List of Files
Summary:
Description:
Syntax:
AzureBlobStorage.OnNewFile_Old (string folderId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderId |
string
|
|
True |
Returns:
Type:string(binary)
Summary:
Description:
Syntax:
AzureBlobStorage.OnUpdatedFile_Old (string folderId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
folderId |
string
|
|
True |
Returns:
Type:string(binary)
Summary:
Description: Blob dataset metadata
Properties:
|
Name |
Type |
Summary |
|
source |
string
|
Blob dataset source |
|
displayName |
string
|
Blob dataset display name |
|
urlEncoding |
string
|
Blob dataset url encoding |
Summary:
Description: Blob metadata
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
The unique id of the file or folder. |
|
Name |
string
|
The name of the file or folder. |
|
DisplayName |
string
|
The display name of the file or folder. |
|
Path |
string
|
The path of the file or folder. |
|
LastModified |
string(date-time)
|
The date and time the file or folder was last modified. |
|
Size |
integer(int64)
|
The size of the file or folder. |
|
MediaType |
string
|
The media type of the file or folder. |
|
IsFolder |
boolean
|
A boolean value (true, false) to indicate whether or not the blob is a folder. |
|
ETag |
string
|
The etag of the file or folder. |
|
FileLocator |
string
|
The filelocator of the file or folder. |
Summary:
Description: Represents a page of blob metadata.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (BlobMetadata)
|
Blob metadata collection. |
|
nextLink |
string
|
An Url which can be used to retrieve the next page. |
|
nextPageMarker |
string Next page marker |
A marker which can be used to retrieve the next page. |
Summary:
Description: Represents blob datasets metadata response
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
The unique id of the file or folder. |
|
Name |
string
|
The name of the file or folder. |
|
DisplayName |
string
|
The display name of the file or folder. |
|
Path |
string
|
The path of the file or folder. |
|
LastModified |
string(date-time)
|
The date and time the file or folder was last modified. |
|
Size |
integer(int64)
|
The size of the file or folder. |
|
MediaType |
string
|
The media type of the file or folder. |
|
IsFolder |
boolean
|
A boolean value (true, false) to indicate whether or not the blob is a folder. |
|
ETag |
string
|
The etag of the file or folder. |
|
FileLocator |
string
|
The filelocator of the file or folder. |
Summary:
Description: Dataset metadata
Properties:
|
Name |
Type |
Summary |
|
tabular |
|
Tabular dataset metadata |
|
blob |
|
Blob dataset metadata |
Summary:
Description: Shared access signature
Properties:
|
Name |
Type |
Summary |
|
WebUrl |
string(uri) Web Url |
A URL to an object with access token. |
Summary:
Description: The set of parameters to generate a SAS link.
Properties:
|
Name |
Type |
Summary |
|
GroupPolicyIdentifier |
string Group Policy Identifier |
The string identifying a stored access policy. The Group policy parameters (e.g. Start time and End time) have precedence over input parameters mentioned in actions. |
|
Permissions |
string Permissions |
The permissions specified on the SAS (Values separated by comma). Values: [Read, Write, Add, Create, Delete, List, Read,Write, Read,Write,List, Read,Write,List,Delete] |
|
StartTime |
string(date-time) Start Time |
The date and time at which the SAS becomes valid (example: '2017-11-01T15:30:00+00:00'). Default = now(). |
|
ExpiryTime |
string(date-time) Expiry Time |
The date and time after which the SAS is no longer valid (example: '2017-12-01T15:30:00+00:00'). Default = now() + 24h. |
|
AccessProtocol |
string Shared Access Protocol |
The allowed protocols (https only, or http and https). Null if you don't want to restrict protocol. Values: [HttpsOnly, HttpsOrHttp] |
|
IpAddressOrRange |
string IP address or IP address range |
The allowed IP address or IP address range. Null if you don't want to restrict based on IP address. |
Summary:
Description: Tabular dataset metadata
Properties:
|
Name |
Type |
Summary |
|
source |
string
|
Dataset source |
|
displayName |
string
|
Dataset display name |
|
urlEncoding |
string
|
Dataset url encoding |
|
tableDisplayName |
string
|
Table display name |
|
tablePluralName |
string
|
Table plural display name |