Microsoft Azure Storage Connector Reference¶
The following operations allow you to work with the Microsoft Azure Storage Connector. Click an operation name to see parameter details and samples on how to use it.
Initialize the connector¶
To use the Microsoft Azure Storage connector, add the
Note: To work with the Microsoft Azure Storage connector, you need to have a Microsoft Azure account. If you do not have a Microsoft Azure account, go to https://azure.microsoft.com/en-in/free/ and create a Microsoft Azure account.
init
The init operation is used to initialize the connection to Microsoft Azure.
Parameter Name | Description | Required |
---|---|---|
accountName | The name of the Azure storage account. | Yes |
accountKey | The access key for the storage account. | Yes |
defaultEndpointsProtocol | Type of the protocol(http/https) to connect. | No |
Sample configuration
<msazurestorage.init>
<accountName>{$ctx:accountName}</accountName>
<accountKey>{$ctx:accountKey}</accountKey>
<defaultEndpointsProtocol>{$ctx:defaultEndpointsProtocol}</defaultEndpointsProtocol>
</msazurestorage.init>
Blobs¶
uploadBlob
The uploadBlob operation uploads a Blob file into the storage. See the related API documentation for more information.
Parameter Name | Description | Required |
---|---|---|
containerName | The name of the container. | Yes |
fileName | The name of the file. | Yes |
filePath | The path to a local file to be uploaded. | Yes |
blobContentType | The Content-type of the file to be uploaded | No |
Sample configuration
<msazurestorage.uploadBlob>
<containerName>{$ctx:containerName}</containerName>
<fileName>{$ctx:fileName}</fileName>
<filePath>{$ctx:filePath}</filePath>
<blobContentType>{$ctx:fileContentType}</blobContentType>
</msazurestorage.uploadBlob>
Sample request
{
"accountName": "test",
"accountKey": "=gCetnaQlvsXQG4PnlXxxxxXXXXsW37DsDKw5rnCg==",
"containerName": "sales",
"fileName": "sample.txt",
"filePath": "/home/user/Pictures/a.txt"
}
deleteBlob
The deleteBlob operation deletes a Blob file from the storage. See the related API documentation for more information.
Parameter Name | Description | Required |
---|---|---|
containerName | The name of the container. | Yes |
fileName | The name of the file. | Yes |
Sample configuration
<msazurestorage.deleteBlob>
<containerName>{$ctx:containerName}</containerName>
<fileName>{$ctx:fileName}</fileName>
</msazurestorage.deleteBlob>
Sample request
{
"accountName": "test",
"accountKey": "=gCetnaQlvsXQG4PnlXxxxxXXXXsW37DsDKw5rnCg==",
"containerName": "sales",
"fileName": "sample.txt"
}
listBlobs
The listBlobs operation retrieves information about all Blobs in a container. See the related API documentation for more information.
Parameter Name | Description | Required |
---|---|---|
containerName | The name of the container. | Yes |
Sample configuration
<msazurestorage.listBlobs>
<containerName>{$ctx:containerName}</containerName>
</msazurestorage.listBlobs>
Sample request
{
"accountName": "test",
"accountKey": "=gCetnaQlvsXQG4PnlXxxxxXXXXsW37DsDKw5rnCg==",
"containerName": "sales"
}
Containers¶
createContainer
The createContainer operation creates a container in the storage. See the related API documentation for more information.
Parameter Name | Description | Required |
---|---|---|
containerName | The name of the container. | Yes |
Sample configuration
<msazurestorage.createContainer>
<containerName>{$ctx:containerName}</containerName>
</msazurestorage.createContainer>
Sample request
{
"accountName": "test",
"accountKey": "=gCetnaQlvsXQG4PnlXxxxxXXXXsW37DsDKw5rnCg==",
"containerName": "sales"
}
deleteContainer
The deleteContainer operation deletes a container from the storage. See the related API documentation for more information.
Parameter Name | Description | Required |
---|---|---|
containerName | The name of the container. | Yes |
Sample configuration
<msazurestorage.deleteContainer>
<containerName>{$ctx:containerName}</containerName>
</msazurestorage.deleteContainer>
Sample request
{
"accountName": "test",
"accountKey": "=gCetnaQlvsXQG4PnlXxxxxXXXXsW37DsDKw5rnCg==",
"containerName": "sales"
}
listContainers
The listContainers operation retrieves information about all containers in the storage. See the related API documentation for more information.
Sample configuration
<msazurestorage.listContainers/>
Sample request
{
"accountName": "test",
"accountKey": "=gCetnaQlvsXQG4PnlXxxxxXXXXsW37DsDKw5rnCg==",
}