SAS Generator
- Lakshmi Manda
- Mohammed Iqbal
- Chandna Mitra
On this page
Overview
This Snap generates a SAS (Shared Access Signature) URI that enable you to access Azure Storage containers or blobs for a specified period. You can use this URI with other Snaps, such as File Writer or File Reader, to interact with the files in the Azure Storage container or blob. See Using SAS for more information on SAS.
Depending upon the Snap's configuration, you can either access all blobs in a container, or a specific blob in a container. See Snap Settings for more information.
SAS Type Compatibility Chart
| Snap Name | Service SAS On Container | Service SAS On Blob | Account SAS |
|---|---|---|---|
| Directory Browser | Yes | No | No |
| File Delete | Yes | Yes | No |
| File Operation | Yes | No | Yes |
| File Poller | Yes | No | No |
| File Reader | Yes | Yes | Yes |
| File Writer | Yes | Yes | Yes |
| Multi File Reader | Yes | No | No |
| ZipFile Read | Yes | Yes | Yes |
| ZipFile Write | Yes | Yes | Yes |
Input and Output
- Expected input: A document containing the key/value pairs required for populating the expression properties in the Snap.
Expected output: A document containing two fields, SasType and SasUri. The following is a sample output document:
- Expected upstream Snaps: Any Snap with a document output view. For example, Mapper, Copy, etc.
Expected downstream Snaps: Compatible Snaps with a document input view. For example, File Reader, Directory Browser, and Multi File Reader.
Prerequisites
- None.
Configuring Accounts
This Snap uses account references created on the Accounts page of the SnapLogic Manager to handle access to this endpoint. This Snap requires an Azure Storage account. See Configuring Binary Accounts for information on setting up accounts that work with this Snap.
Configuring Views
Input | This Snap has at most one optional document input view. It may contain values to evaluate expression properties in SAS Generator Snap. |
|---|---|
| Output | This Snap has exactly one output view. |
| Error | This Snap has at most one document error view. |
Troubleshooting
- None.
Support
- Works in Ultra Pipelines.
Known Issues
- None.
Snap Settings
| Label | Required. The name for the Snap. Modify this to be more specific, especially if there are more than one of the same Snap in the Pipeline. |
|---|---|
| Container | The name of the Azure Storage container that you want to access. Enter the name or select one suggested by the Snap. This property is required for Service SAS on container and Service SAS on blob. The container's name must always be in lowercase. See Referencing Containers and Blobs for more information. |
| Blob | The name of the Azure Storage blob that you want to access. Enter the name or select one suggested by the Snap. Blob name should be a relative path in the container.
Default value: N/A Leave this property blank to access all the blobs in the specified container. |
| Protocol | The protocol over which Azure Storage permits access to the client using the SAS URI. Available options are:
Default value: https |
| SAS Permissions | Select the file-access permissions that you want to assign to users of the SAS URI. See Specifying Permissions for more information. Available options are:
Default value: READ, WRITE, LIST, DELETE |
| Expire in (hours) | Specifies the validity of the SAS URI in hours. Configure this property and the Expire in (minutes) property to specify the total duration of the URI's validity. |
| Expire in (minutes) | Specifies the expire time in minutes. Example: 10 Minimum value: 0 Default value: 1 |
| Snap Execution | Select one of the following three modes in which the Snap executes:
Default Value: Execute only |
Understanding the SAS URI Validity
The validity of the SAS URI is determined by the values in the Expire in (hours) and Expire in (minutes) properties. For example, if the SAS Generator Snap is configured as shown below, the validity of the SAS URI generated by the Snap is 3 hours and 43 minutes.
