Azure Storage - List blobs
Declaration
<AMAZURESTORAGE ACTIVITY="list_blobs" SESSION="text" ACCOUNTNAME="text" ACCESSKEY="text (encrypted)" PROTOCOL="text (options)" TIMEOUT="number" BLOBENDPOINT="text" QUEUEENDPOINT="text" TABLEENDPOINT="text" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)" RESULTDATASET="text" CONTAINER="text" LISTING="text (options)" USEFLATLISTING="YES/NO" />
Description
Enumerates the list of blobs under the specified container.
Practical usage
Commonly used to add header or footer information to a new or existing PDF file which can be used to present consistent data, such as date, time, document title or company logo.
Parameters
Connection
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Connection | --- | --- | --- | --- | Indicates where user
credentials and preferences should originate from. The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Connection - Session
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Session | Text | Yes, if Connection is set to Session | AzureStorageSession1 | SESSION="MyAzureSession" | The
name of the Azure Storage session to create. The default value
is AzureStorageSession1. NOTE: Use the Azure Storage - End session
activity to end an active Azure Storage session. |
Connection - Host > Credentials
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Account name | Text | Yes, if Connection is set to Host | (Empty) | ACCOUNTNAME="myaccount" | The globally unique name of the Windows Azure storage account. |
Access key | Text | Yes, if Connection is set to Host | (Empty) | ACCESSKEY="[AccessKey]" | The primary or secondary access key (each composed of 88 ASCII characters) used to authorize access to Azure Storage. |
Connection - Host > Advanced
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Protocol | Text (options) | No | HTTPS |
|
The
type of protocol used to access Azure Storage. The available options
are:
|
Timeout (seconds) | Number | No | 90 | TIMEOUT="180" | The timeout interval (in seconds) for requests made to the storage service. If the timeout elapses before a server response is returned, the operation times out and the service returns an error. The default timeout value is 90 seconds. |
Blob endpoint URI | Text | No | (Empty) | BLOBENDPOINT="http://accnt.blob.core.windows.net" | The endpoint for the Blob service, as configured for the Azure Storage account. The default Blob service endpoint is [http/https]://accountname.blob.core.windows.net, where accountname is the name of the Azure Storage account. |
Queue endpoint URI | Text | No | (Empty) | QUEUEENDPOINT="http://accnt.queue.core.windows.net" | The endpoint for the Queue service, as configured for the Azure storage account. The default Queue service endpoint is [http/https]://accountname.queue.core.windows.net, where accountname is the name of the Azure Storage account. |
Table endpoint URI | Text | No | (Empty) | TABLEENDPOINT="http://accnt.table.core.windows.net" | The endpoint for the Table service, as configured for the Azure storage account. The default Table service endpoint is [http|https]://accountname.table.core.windows.net, where accountname is the name of the Azure Storage account. |
Proxy type | Text (options) | Yes | System default |
|
The
type of proxy required for SharePoint connections passing through
a proxy server. The available options are:
|
Use authentication | --- | No | --- | --- | If
enabled, specifies proxy authentication is required,
enabling authentication-based parameters (disabled by default).
It is active only if the Proxy
type parameter is set to HTTP. NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Proxy server | Text | Yes, if Proxy type is set to HTTP | (Empty) | PROXYSERVER="proxy.host.com" | The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. |
Proxy username | Text | No | (Empty) | PROXYUSERNAME="username" | The proxy username to authenticate with. This parameter is available only if Use authentication is enabled. |
Proxy port | Number | No | 808 | PROXYPORT="8080" | The port number to use to connect to the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. The default value is 808. |
Proxy password | Text | No | (Empty) | PROXYPASSWORD="encrypted" | The proxy password to authenticate with. This parameter is available only if Use authentication is enabled. |
Blob
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Container name | Text | Yes | (Empty) | CONTAINER="mycontainer" | The unique name of the container in which to retrieve the list of blobs from. |
Listing details | Text (options) | No | None |
|
Specifies
one or more blob details to include in the response. The available
options are:
|
Use flat listing | Yes/No | No | Yes | SOURCE="C:\PDFFileName.pdf" | If set to Yes, the blob listing operation will list all blobs within a container by way of a flat listing. If set to No, it will list blobs hierarchically, by virtual directory. |
Create and populate dataset with blob names | Text | Yes | (Empty) | RESULTDATASET="theBlobInfo" | The name of the dataset to create and populate with blob information. Details regarding the dataset names/return values that this activity creates can be found below under Datasets. |
Additional notes
Datasets
A dataset is a multi-column, multi-row object that contains a collection of information gathered during execution of an activity and stored in memory. This activity creates and populates a dataset with the following fields (rows):
Name | Type | Return Value | |||
---|---|---|---|---|---|
theDataset.ETag | Text | The blob's Etag value (for example, 0x8CE71042DD2B12A). | |||
theDataset.LastModifiedUTC | Date | The last modified date/time for the blob (for example, 11/14/2022 4:47:06 PM). | |||
theDataset.Metadata | Text | The blob's metadata (if any). | |||
theDataset.Name | Text | The unique name of the blob. | |||
theDataset.Uri | Text | The blob address. | |||
theDataset.Snapshot | Date | The snapshot date time value. |
Example
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
List blobs from container "mycontainer" and store its information into dataset "theDataset". Azure account name is "netauto".
<AMAZURESTORAGE ACTIVITY="list_blobs" RESULTDATASET="theDataset" CONTAINER="mycontainer" LISTING="All" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" PROXYTYPE="none" />