Azure Storage - Get public URL
Declaration
<AMAZURESTORAGE ACTIVITY="access_signature" 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)" CONTAINER="text" BLOB="text" READ="YES/NO" WRITE="YES/NO" DELETE="YES/NO" LIST="YES/NO" STARTTIME="%DateSerial+TimeSerial" EXPIRYTIME="%DateSerial+TimeSerial%" POLICY="text" RESULTVARIABLE="text" />
Description
Sets a blob container to be publicly available by changing its public access permissions and retrieving the resource by its newly created public URL.
Practical usage
Commonly used to make a private blob container publicly available in order for other users to browse through the contents of the blob.
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 that contains the blob to modify. |
Blob name | Text | Yes | (Empty) | BLOB="myblob" | The unique name of the blob to modify. |
Container policy | Text | No | (Empty) | POLICY="thepolicy" | The name of the policy to set. If this parameter is selected, the Custom policy parameter becomes inactive. |
Custom policy | --- | --- | --- | --- | Specifies
that a custom set of policies (specified below) will be set for
the blob container. If this parameter is selected, the Container
policy parameter becomes inactive. NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Read | Yes/No | No | No | READ="yes" | If selected, read access is granted. Is disabled, read access is denied. This parameter is active only if the Custom policy parameter is selected. |
Write | Yes/No | No | No | WRITE="yes" | If selected, write access is granted. Is disabled, write access is denied. This parameter is active only if the Custom policy parameter is selected. |
Delete | Yes/No | No | No | DELETE="no" | If selected, delete access is granted. Is disabled, delete access is denied. This parameter is active only if the Custom policy parameter is selected. |
List | Yes/No | No | No | LIST="yes" | If selected, listing access is granted. Is disabled, listing access is denied. This parameter is active only if the Custom policy parameter is selected. |
Start time | Date | No | Current date/time | %DateSerial(2012,12,03)+TimeSerial(14,16,16)% | The start time of the access signature. If you do not provide a date/time, the default value will be the moment of creation. This parameter is active only if the Custom policy parameter is selected. Click Custom to select a custom value. Enable Expression to enter a date/time expression. |
Expiry time | Date | No | Current date/time | %DateSerial(2012,12,03)+TimeSerial(14,16,16)% | The date/time specifying when the access signature will expire. After expiration, the signature will no longer be valid to execute the operations on the resource. This parameter is active only if the Custom policy parameter is selected. Click Custom to select a custom value. Enable Expression to enter a date/time expression. |
Populate variable with public URL | Text | Yes | (Empty) | RESULTVARIABLE="theVar" | An existing variable to populate with the newly generated public URL. |
Example
NOTE:
- 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
This sample task gets the public URL for a blob.
Copy
<AMVARIABLE NAME="myVar" />
<AMAZURESTORAGE ACTIVITY="access_signature" CONTAINER="mycontainer" BLOB="largeblob1.txt" WRITE="yes" DELETE="yes" LIST="yes" STARTTIME="%DateSerial(2012,12,03)+TimeSerial(14,16,16)%" EXPIRYTIME="%DateSerial(2012,12,03)+TimeSerial(14,16,16)%" RESULTVARIABLE="myVar" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" PROXYTYPE="none" />