Skip to content

Commit a396c80

Browse files
Create azure-blob-storage-connector.md
Setup documentation for the Azure Blob Storage Connector
1 parent 70eba34 commit a396c80

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: "Azure Blob Storage"
3+
url: /appstore/modules/azure/azure-blob-storage/
4+
description: "Describes the configuration and usage of the Azure Blob Storage connector, which is available in the Mendix Marketplace. Azure Blob Storage is an object storage service offering industry-leading scalability, data availability, security, and performance."
5+
weight: 20
6+
aliases:
7+
- /appstore/connectors/azure-blob-storage-connector/
8+
- /appstore/connectors/azure/azure-blob-storage/
9+
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
10+
---
11+
12+
## Introduction
13+
14+
The [Azure Blob Storage](https://marketplace.mendix.com/link/component/<insert when published>) connector enables you to connect your app to [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs) and easily store objects.
15+
16+
### Typical Use Cases
17+
18+
The Azure Blob Storage service is an object storage service offering industry-leading scalability, data availability, security, and performance. Customers of all sizes and industries can store and protect any amount of data for virtually any use case. With cost-effective storage types and easy-to-use management features, you can optimize costs, organize data, and configure fine-tuned access controls to meet specific business, organizational, and compliance requirements. Some typical use cases of Azure Blob Storage are:
19+
20+
* Back up and restore critical data - Meet Recovery Time Objectives (RTO), Recovery Point Objectives (RPO), and compliance requirements with Bolb storage's robust replication features.
21+
* Archive data at the lowest cost - Move data archives to the Azure Blob Storage to eliminate operational complexities, and gain new insights.
22+
23+
### Prerequisites {#prerequisites}
24+
25+
The Azure Blob Storage Connector requires Mendix Studio Pro version 9.24.2 or above.
26+
27+
### Licensing and Cost
28+
29+
This connector is available as a free download from the Mendix Marketplace, but the Azure service to which it connects may incur a usage cost. For more information, refer to Azure documentation.
30+
31+
Depending on your use case, your deployment environment, and the type of app that you want to build, you may also need a license for your Mendix app. For more information, refer to [Licensing Apps](/developerportal/deploy/licensing-apps-outside-mxcloud/).
32+
33+
## Installation
34+
35+
Follow the instructions in [How to Use Marketplace Content](/appstore/use-content/) to import the Azure Blob Storage connector into your app.
36+
37+
## Configuration
38+
39+
After you install the connector, you can find it in the **App Explorer**, in the **AzureBlobStorageConnector** section. The connector provides a domain model and operations that you can use to connect your app to Azure Blob Storage. Each operation can be implemented using it in a microflow or nanoflow.
40+
41+
### Configuring Authentication {#authentication}
42+
43+
In order to use the Azure Blob Storage service, you must authenticate using a Shared Access Signature (SAS). To do so, you must create a SAS or ask your Azure admin to do that for you. The SAS is then added to a ConnectionDetails object on the SAS attribute. In addition you will need to set the storage account to the Connection details on the StorageAccount attribute.
44+
45+
We plan to provide additional means of authentication soon.
46+
47+
### Configuring a Microflow for an AWS Service
48+
49+
You can implement the operations of the connector by using them in microflows. For example, to upload a Blob to the Azure Blob Storage, implement the **PUT_v1_Azure_PutBlob** operation by performing the following steps:
50+
51+
1. In the **App Explorer**, right-click on the name of your module, and then click **Add microflow**.
52+
2. Enter a name for your microflow, for example, *ACT_PutBlob*, and then click **OK**.
53+
3. In the **App Explorer**, in the **AzureBlobStorageConnector** section, find the **PUT_v1_Azure_PutBlob** operation microflow.
54+
4. In the **App Explorer**, in the **AWSAuthentication** section, find the **GetStaticCredentials** and **GetTemporaryCredentials** microflows.
55+
5. Drag the **PUT_v1_Azure_PutBlob** microflow in to your microflow.
56+
6. Double-click the **PUT_v1_Azure_PutBlob** operation to configure the required parameters.
57+
58+
For the `PUT_v1_Azure_PutBlob` operation, retrieve the `System.FileDocument` you want to store and provide a configured `ConnectionDetails` object. You must then create a `PutBlobRequest` object in your microflow as the last parameter. This entity requires the following parameters:
59+
60+
* `BlobName` - The BlobName attribute holds the name the blob will get in the Blob storage.
61+
* `ContainerName` - The ContainerName attribute holds the target container name where the blob will be stored.
62+
* `BlobType` - The BlobType attribute holds the type of blob that will be created. For now we only support the BlockBlob option.
63+
64+
The following parameters are optional:
65+
* `ContentType` - Optional. The ContentType attribute can be used to specify the MIME content type of the blob. The default type is application/octet-stream.
66+
* `StorageType` - Optional. The StorageType attribute specifies the storage tier to be set on the blob. For page blobs on a Premium Storage account only with version 2017-04-17 and later. For a full list of page blob-supported tiers, see https://learn.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssd. For block blobs, supported on blob storage or general purpose v2 accounts only with version 2018-11-09 and later. Valid values for block blob tiers are Hot, Cool, Cold, and Archive. Note: Cold tier is supported for version 2021-12-02 and later. For detailed information about block blob tiering, see https://learn.microsoft.com/en-us/azure/storage/blobs/access-tiers-overview.
67+
68+
9. Configure a method to trigger the `ACT_PutBlob` microflow.
69+
For example, you can call the microflow with a custom button on a page in your app. For an example of how this can be implemented, see [Creating a Custom Save Button with a Microflow](/refguide/creating-a-custom-save-button/).
70+
71+
## Technical Reference {#technical-reference}
72+
73+
The module includes technical reference documentation for the available entities, enumerations, activities, and other items that you can use in your application. You can view the information about each object in context by using the **Documentation** pane in Studio Pro.
74+
75+
The **Documentation** pane displays the documentation for the currently selected element. To view it, perform the following steps:
76+
77+
1. In the [View menu](/refguide/view-menu/) of Studio Pro, select **Documentation**.
78+
2. Click on the element for which you want to view the documentation.
79+
80+
{{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" class="no-border" >}}
81+
82+
For additional reference, the available activities are listed below.
83+
84+
### Operations
85+
86+
[Operations](/refguide/Operations/) define the operations that are executed in a microflow or a nanoflow.
87+
88+
The Azure Blob Storage connector contains the following activities:
89+
90+
* `PutBlob` - Allows you to upload, as a Blob, a file of any type, to Azure Blob Storage. For more information, see [Put Blob to Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob).

0 commit comments

Comments
 (0)