Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters
    ActiveCampaign
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Bing Search
    ConstantContact
    Couchbase
    CSV
    DB (RDBMS)
    Dropbox
    Files
    Flight Aware
    FreshBooks
    FTP
    Geonames
    GoogleDrive
    GoogleSearch
    GoogleSheet
    GreenMile
    GpsInsight
    HttpEndpoint (REST)
    Intacct
    Insteon
    Loggly
    MailChimp
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    OneDrive
    OneDrive365 (Business)
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    Slack
    SQL Server
    SQLX
    Sudoku
    Teams
    Threading
    Twilio
    Twitter
    VellemanDMX
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/azurestorage




Azure Storage


The Azure Storage adapter provides advanced access to Azure Queues, Azure Tables and Azure Blobs (including Blob Containers, Block Blobs, and Page Blobs).


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String account Windows Azure Storage Account name
String key Account Key of the storage account (primary or secondary)
Boolean useSSL When true, use SSL when connecting to the storage account True
Int32 retries Number of retries if cloud connection failure 3
Int32 urlShortener URL shorting strategy (where applicable). 0: None (default), 1:Google 0
String urlShortenerKey Shortener API key to use
Boolean isPublic Access to the data is public False
String publicUrl Public access URL to reference data

Handlers



CreateVirtualTable Creates a virtual table that is used to access table data directly details 

Arguments

Name Description Default
name R Name of the virtual table to create
table R The name of the Azure Table to access
columns R List of properties for this virtual table

SQL Call

exec AzureStorage.CreateVirtualTable 'myTable', 'table1', 'int id,string name'


Http Call

/bsc/azurestorage/createvirtualtable

Output Columns

This call does not return data.

DeleteVirtualTable Deletes a virtual table details 

Arguments

Name Description Default
name R The name of the virtual table

SQL Call

exec AzureStorage.DeleteVirtualTable 'myTable'


Http Call

/bsc/azurestorage/deletevirtualtable

Output Columns

This call does not return data.

ListVirtualTable Gets a list of virtual tables previously created details 

Arguments


SQL Call

exec AzureStorage.ListVirtualTable 'myTable'


Http Call

/bsc/azurestorage/listvirtualtable

Output Columns

String tableNameThe name of the virtual table
String shardNameThe name of the shard
String commentA command for the table
String columnsList of columns that defines this table
UpdateVirtualTable Updates a virtual table that is used to access bucket data directly details 

Arguments

Name Description Default
name R Name of the virtual table to update
table R The name of the Azure Table
columns R List of properties for this table

SQL Call

exec AzureStorage.UpdateVirtualTable 'myTable', 'table1', 'int id,string name'


Http Call

/bsc/azurestorage/updatevirtualtable

Output Columns

This call does not return data.

BlobContainerExists Returns true if a blob container exists in the storage account details 

Arguments

Name Description Default
container R Name of the Blob Container to find

SQL Call

EXEC AzureStorage.BlobContainerExists 'mycontainer'


Http Call

/bsc/azurestorage/blobcontainerexists

Output Columns

String existsReturns true if a blob container exists
CreateBlobContainer Create a blob container in the storage account details 

Arguments

Name Description Default
container R Unique name for the Blob Container to create

SQL Call

EXEC AzureStorage.CreateBlobContainer 'mycontainer'
INSERT INTO AzureStorage.BlobContainers (container) VALUES ('mycontainer')


Http Call

/bsc/azurestorage/createblobcontainer

Output Columns

This call does not return data.

DeleteBlob Delete a blob inside a blob container details 

Arguments

Name Description Default
container R Unique name for the Blob Container
name R Unique name for the Blob to delete
leaseId The Lease Id, if any

SQL Call

EXEC AzureStorage.DeleteBlob 'mycontainer', 'blobname'
DELETE FROM Blobs WHERE container = 'mycontainer' AND name = 'blobname'


Http Call

/bsc/azurestorage/deleteblob

Output Columns

This call does not return data.

DeleteBlobContainer Delete a blob container in the storage account details 

Arguments

Name Description Default
container R Unique name for the Blob Container to delete

SQL Call

EXEC AzureStorage.DeleteBlobContainer 'mycontainer'
DELETE FROM AzureStorage.BlobContainers WHERE container = 'mycontainer'


Http Call

/bsc/azurestorage/deleteblobcontainer

Output Columns

This call does not return data.

GetBlob Retrieves the content of a blob details 

Arguments

Name Description Default
container Unique name for the Blob Container
name R Unique name for the Blob
leaseId The Lease Id, if any

SQL Call

EXEC AzureStorage.GetBlob 'mycontainer', 'blobname'
SELECT * FROM Blob WHERE container = 'mycontainer' AND name = 'blobname'
SELECT * FROM Blob@mycontainer WHERE name = 'blobname'


Http Call

/bsc/azurestorage/getblob

Output Columns

String typeThe blob type (block or page)
String contentTypeThe blob content type
DateTime lastModifiedThe last modified date of the blob
String leaseStatusThe lease status of the blob
Int64 lengthThe blob length
String nameThe blob name
DateTime snapshotThe blob snapshot, if any
Object contentThe blob content
GetBlobContainerDetails Returns a list of properties and metadata for a blob container given its name details 

Arguments

Name Description Default
container R Unique name for the Blob Containers

SQL Call

EXEC AzureStorage.GetBlobContainerDetails 'newcontainer'
SELECT * FROM AzureStorage.BlobContainerDetails WHERE container='mycontainer'


Http Call

/bsc/azurestorage/getblobcontainerdetails

Output Columns

String nameProperty name
String valueProperty value
String typeThe type of property
GetBlobContainers Virtual table of blob containers in the storage account details 

Arguments

Name Description Default
nameStartsWith The starting name of the Blob Containers to return
top Maximum number of rows to return (0 returns all) 0

SQL Call

EXEC AzureStorage.GetBlobContainers
SELECT * FROM AzureStorage.BlobContainers
SELECT * FROM AzureStorage.BlobContainers WHERE nameStartsWith = 'test' and top = 10


Http Call

/bsc/azurestorage/getblobcontainers

Output Columns

String nameBlob container name
GetBlobDetails Gets the properties and metadata of a blob details 

Arguments

Name Description Default
container R Unique name for the Blob Container
name R Unique name for the Blob

SQL Call

EXEC AzureStorage.GetBlobDetails 'mycontainer', 'blobname'
SELECT * FROM BlobDetails WHERE container = 'mycontainer' AND name = 'blobname'


Http Call

/bsc/azurestorage/getblobdetails

Output Columns

String nameProperty name
String valueProperty value
String typeThe type of property
GetBlobs List of blobs found inside a blob container details 

Arguments

Name Description Default
container R Unique name for the Blob Container
startsWith The starting name of the Blobs to retrieve (leave blank to return all)
top Maximum number of blobs to return 0

SQL Call

EXEC AzureStorage.GetBlobs 'newcontainer'
SELECT * FROM Blobs WHERE container = 'newcontainer'


Http Call

/bsc/azurestorage/getblobs

Output Columns

String nameUnique name for the Blob
RemoveBlobMetadata Removes metadata on a blob details 

Arguments

Name Description Default
container R Unique name for the Blob Container
name R Unique name for the Blob
key R The key of the metadata
leaseId The Lease Id, if any

SQL Call

EXEC AzureStorage.RemoveBlobMetadata 'mycontainer', 'blobname', 'metadatakey', 'metadatavalue'
DELETE FROM BlobDetails WHERE key='mykey' AND container = 'mycontainer' AND name = 'blobname'


Http Call

/bsc/azurestorage/removeblobmetadata

Output Columns

This call does not return data.

SaveBlob Creates or updates a blob in a blob container details 

Arguments

Name Description Default
container R Unique name for the Blob Container
name R Unique name for the Blob
type R Type of Blob (Page or Block)
content R The byte array for the content of the blob
mime The mime type for the blob

SQL Call

EXEC AzureStorage.SaveBlob 'mycontainer', 'blobname'
INSERT INTO AzureStorage.Blob () VALUES ('mycontainer', 'blobname')


Http Call

/bsc/azurestorage/saveblob

Output Columns

This call does not return data.

SaveFileBlob Creates or updates a blob in a blob container for access via a future http request details 

Arguments

Name Description Default
container R Unique name of the Blob Container
name R Unique name for the Blob
filespec R The file URI containing the content of the blob
mime The mime type for the blob image/png
type Type of Blob (Page or Block) block

SQL Call

EXEC AzureStorage.SaveFileBlob 'mycontainer', 'blobname'
INSERT INTO AzureStorage.FileBlob () VALUES ('mycontainer', 'blobname')


Http Call

/bsc/azurestorage/savefileblob

Output Columns

String longUrl
String shortUrl
SetBlobContainerMetadata Updates the metadata of a blob container details 

Arguments

Name Description Default
container R Unique name for the Blob Container
key R The key of the metadata entry
value R The value of the metadata entry

SQL Call

EXEC AzureStorage.SetBlobContainerMetadata 'mycontainer', 'metadatakeyname', 'value'
UPDATE AzureStorage.BlobContainerDetails SET key='metadatakeyname', value='value' WHERE container='mycontainer'


Http Call

/bsc/azurestorage/setblobcontainermetadata

Output Columns

This call does not return data.

SetBlobMetadata Saves or updates metadata on a blob details 

Arguments

Name Description Default
container R Unique name for the Blob Container
name R Unique name for the Blob
key R The key of the metadata
value R The value of the metadata
leaseId The Lease Id, if any

SQL Call

EXEC AzureStorage.SetBlobMetadata 'mycontainer', 'blobname', 'metadatakey', 'metadatavalue'
UPDATE BlobDetails SET key='mykey', value='myvalue' WHERE container = 'mycontainer' AND name = 'blobname'


Http Call

/bsc/azurestorage/setblobmetadata

Output Columns

This call does not return data.

DeleteEntity Deletes an entity from an Azure Table details 

Arguments

Name Description Default
tableName R The name of the Azure Table
partitionKey The PartitionKey of the entity to retrieve
rowKey The RowKey of the entity to retrieve

SQL Call

exec AzureStorage.DeleteEntity 'mytable', 'partitionKey', 'rowKey'


Http Call

/bsc/azurestorage/deleteentity

Output Columns

This call does not return data.

GetEntities Returns all the entities from an Azure Table details 

Arguments

Name Description Default
tableName R The name of the Azure Table
columns The columns to retrieve seperated by a comma
filter The filter to use when fetching entities
continuationToken The continuation token when fetching additional entities
paging The number of records to return (1000 max) 100

SQL Call

exec AzureStorage.GetEntities 'mytable'
SELECT * FROM AzureStorage.Entities WHERE tableName = 'Table1'


Http Call

/bsc/azurestorage/getentities

Output Columns

This call does not return data.

SaveEntity Adds or updates an entity in an Azure Table details 

Arguments

Name Description Default
tableName R The name of the Azure Table
xml An XML document that represents the data to save
mode Specifies whether the operation to perform (upsert,insert,update) upsert

SQL Call

exec AzureStorage.SaveEntity 'mytable', '00119'


Http Call

/bsc/azurestorage/saveentity

Output Columns

This call does not return data.

SeekEntity Returns a single entity from an Azure Table details 

Arguments

Name Description Default
tableName R The name of the Azure Table
partitionKey R The PartitionKey of the entity to retrieve
rowKey R The RowKey of the entity to retrieve
columns The columns to retrieve seperated by a comma

SQL Call

exec AzureStorage.SeekEntity 'mytable', '', 'partitionKey', 'rowKey'
SELECT * FROM AzureStorage.Entity WHERE PartitionKey = '' AND RowKey = ''


Http Call

/bsc/azurestorage/seekentity

Output Columns

This call does not return data.

ClearQueue Removes all messages from an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue

SQL Call

EXEC AzureStorage.ClearQueue 'newqueue'


Http Call

/bsc/azurestorage/clearqueue

Output Columns

This call does not return data.

CreateQueue Creates a new Azure Queue details 

Arguments

Name Description Default
name R The name of the queue to create

SQL Call

EXEC AzureStorage.CreateQueue 'newqueue'
INSERT INTO AzureStorage.Queues (name) VALUES ('newqueue')


Http Call

/bsc/azurestorage/createqueue

Output Columns

This call does not return data.

DeleteMessage Deletes a message from an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue
id R The message id to delete
receipt R The receipt of the get operation that fetched the message

SQL Call

EXEC AzureStorage.DeleteMessage 'newqueue', 'message-id', 'pop-receipt'


Http Call

/bsc/azurestorage/deletemessage

Output Columns

This call does not return data.

DeleteQueue Deletes an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue to delete

SQL Call

EXEC AzureStorage.DeleteQueue 'newqueue'
DELETE FROM AzureStorage.Queues WHERE name = 'newqueue'


Http Call

/bsc/azurestorage/deletequeue

Output Columns

This call does not return data.

GetMessageCountQueues Retrieves the approximate count of messages in an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue

SQL Call

EXEC AzureStorage.GetMessageCount 'newqueue'


Http Call

/bsc/azurestorage/getmessagecountqueues

Output Columns

Int32 countThe approximate number of messages in the queue
GetMessages Retrieves the next message(s) in an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue
count Number of messages to read from queue (max is 32) 0
visibility Optionally specifies the visibility timeout of a message 0
remove Optionally removes the message from the queue once read False

SQL Call

EXEC AzureStorage.GetMessages 'newqueue'
SELECT * FROM AzureStorage.Queue WHERE name = 'newqueue'


Http Call

/bsc/azurestorage/getmessages

Output Columns

String contentThe message as a string
Object contentBytesThe message as a byte array
Int32 dequeueCountDequeue count of the message
String idThe message id
String receiptThe pop receipt id of the message
DateTime insertionDateDate the message was created
DateTime nextVisibleOnDate the message will be visible again
DateTime expirationDateDate the message will expire
GetQueueDetails Gets metadata and properties from an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue

SQL Call

EXEC AzureStorage.GetQueueDetails 'myqueue'
SELECT * FROM AzureStorage.QueueDetails WHERE name = 'myqueue'


Http Call

/bsc/azurestorage/getqueuedetails

Output Columns

String nameProperty name
String valueProperty value
String typeThe type of property
ListQueues Retrieves the list of Azure Queues details 

Arguments

Name Description Default
nameStartsWith Filters by queue names that start with the specified string value
top The number of records to return 0

SQL Call

EXEC AzureStorage.ListQueues
SELECT * FROM Queues


Http Call

/bsc/azurestorage/listqueues

Output Columns

String nameThe name of the Azure Queue
PeekMessage Peeks at the next message in an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue

SQL Call

EXEC AzureStorage.PeekMessage 'newqueue'
SELECT * FROM AzureStorage.PeekQueue WHERE name = 'newqueue'


Http Call

/bsc/azurestorage/peekmessage

Output Columns

String contentThe message as a string
Object contentBytesThe message as a byte array
Int32 dequeueCountDequeue count of the message
String idThe message id
DateTime insertionDateDate the message was created
DateTime nextVisibleOnDate the message will be visible again
DateTime expirationDateDate the message will expire
RemoveQueueMetadata Removes metadata on an Azure Queue details 

Arguments

Name Description Default
name R The name of the Azure Queue
key R The key of the metadata

SQL Call

EXEC AzureStorage.RemoveQueueMetadata 'myqueue', 'metadatakey'
DELETE FROM QueueDetails WHERE name = 'myqueue' AND key = 'metadatakey'


Http Call

/bsc/azurestorage/removequeuemetadata

Output Columns

This call does not return data.

SendMessage Inserts a message in an Azure Queue details 

Arguments

Name Description Default
name R The name of the queue
content R The message to send
ttl The TTL for the message 0

SQL Call

EXEC AzureStorage.SendMessage 'newqueue', 'test message'
INSERT INTO AzureStorage.Queue (name, content) VALUES ('newqueue', 'test message')


Http Call

/bsc/azurestorage/sendmessage

Output Columns

This call does not return data.

SetQueueMetadata Saves or updates metadata on an Azure Queue details 

Arguments

Name Description Default
name R The name of the Azure Queue
key R The key of the metadata
value R The value of the metadata

SQL Call

EXEC AzureStorage.SetQueueMetadata 'myqueue', 'metadatakey', 'metadatavalue'
UPDATE QueueDetails SET key='mykey', value='myvalue' WHERE name = 'myqueue'


Http Call

/bsc/azurestorage/setqueuemetadata

Output Columns

This call does not return data.

CreateTable Creates an Azure Table details 

Arguments

Name Description Default
tableName R The name of the Azure Table

SQL Call

exec AzureStorage.CreateTable 'mytable'
INSERT INTO AzureTables (tableName) VALUES ('mytable')


Http Call

/bsc/azurestorage/createtable

Output Columns

This call does not return data.

DefineTableColumn Defines or updates the schema definition of an Azure Table one column at a time. PartitionKey and RowKey are automatically added. details 

Arguments

Name Description Default
tableName R The name of an Azure Table
columnName R The name of a column in the Azure Table
dataType The type of the column (string, boolean, byte[], int, long, datetime, guid, double) string

SQL Call

EXEC AzureStorage.DefineTableColumn 'mytable', 'id', 'int'


Http Call

/bsc/azurestorage/definetablecolumn

Output Columns

This call does not return data.

DefineTableColumns Defines or updates the schema definition of an Azure Table details 

Arguments

Name Description Default
tableName R The name of an Azure Table
columns R A comma-separated list of columns (ex: int id,string name). PartitionKey and RowKey are automatically added.

SQL Call

EXEC AzureStorage.DefineTableColumns 'mytable', 'int id,string name,datetime effdate'


Http Call

/bsc/azurestorage/definetablecolumns

Output Columns

This call does not return data.

DeleteTable Deletes an Azure Table details 

Arguments

Name Description Default
tableName R The name of the Azure Table

SQL Call

exec AzureStorage.DeleteTable 'mytable'
DELETE FROM AzureTables WHERE tableName = 'mytable'


Http Call

/bsc/azurestorage/deletetable

Output Columns

This call does not return data.

DeleteTableEntities DELETE tablename pass-through details 

Arguments

Name Description Default
PartitionKey The PartitionKey of the entity to delete
RowKey The RowKey of the entity to delete

SQL Call

DELETE FROM AzureStorage.table@MyTable2 WHERE PartitionKey = '123' AND RowKey = '25'


Http Call

/bsc/azurestorage/deletetableentities

Output Columns

This call does not return data.

GetTables Lists existing Azure Tables details 

Arguments

Name Description Default
tableName Returns the table names that contain this value

SQL Call

exec AzureStorage.GetTables 'mytable'
SELECT * FROM AzureStorage.AzureTables
SELECT * FROM AzureStorage.AzureTables WHERE nameContains = 'mytable'


Http Call

/bsc/azurestorage/gettables

Output Columns

String name
InsertTableEntities INSERT tablename pass-through details 

Arguments


SQL Call

INSERT INTO AzureStorage.table@MyTable2 (col1, col2) VALUES ('123', 25)


Http Call

/bsc/azurestorage/inserttableentities

Output Columns

This call does not return data.

SelectTableEntities SELECT tablename pass-through details 

Arguments


SQL Call

select * from AzureStorage.table@MyTable1
select PartitionKey, RowKey, Timestamp, MyColumn1 from AzureStorage.table@MyTable2
select * from AzureStorage.table@MyTable2 where PartitionKey = '12345' AND State='FL'


Http Call

/bsc/azurestorage/selecttableentities

Output Columns

This call does not return data.

TableExists Checks whether an Azure Table already exists details 

Arguments

Name Description Default
tableName R The name of the Azure Table

SQL Call

exec AzureStorage.TableExists 'mytable'


Http Call

/bsc/azurestorage/tableexists

Output Columns

This call does not return data.

UpdateTableEntities UPDATE tablename pass-through details 

Arguments

Name Description Default
PartitionKey The PartitionKey of the entity to delete
RowKey The RowKey of the entity to delete

SQL Call

UPDATE AzureStorage.table@MyTable2 SET col1 = '123' WHERE PartitionKey = '123' AND RowKey = '25'


Http Call

/bsc/azurestorage/updatetableentities

Output Columns

This call does not return data.