From 6ff1d53b2d76bda63f97f5817a78c637b6715c86 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Tue, 15 Jul 2025 14:34:12 +0200 Subject: [PATCH 01/13] Azure Blob Storage --- .../modules/azure/_index.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 content/en/docs/marketplace/platform-supported-content/modules/azure/_index.md diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/_index.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/_index.md new file mode 100644 index 00000000000..76be8bdf9b7 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/_index.md @@ -0,0 +1,14 @@ +--- +title: "Azure Modules" +url: /appstore/azure-modules/ +description: "Presents details on the Microsoft Azure-specific connectors available in the Mendix Marketplace." +weight: 40 +no_list: false +description_list: true +--- + +## Introduction + +Mendix has connectors available for users who want to integrate their app with Microsoft Azure. + +## Documents in This Category From dcd44f56414d6aac4a991487b8613689ab0f0a91 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Tue, 15 Jul 2025 15:23:05 +0200 Subject: [PATCH 02/13] moved file --- .../modules/azure/azure-blob-storage-connector.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename content/en/docs/{appstore/use-content => marketplace}/platform-supported-content/modules/azure/azure-blob-storage-connector.md (100%) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md similarity index 100% rename from content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md rename to content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md From a339e090516e733789eeeddb8fa7603c3c49b4ee Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Tue, 15 Jul 2025 15:24:58 +0200 Subject: [PATCH 03/13] Update azure-blob-storage-connector.md --- .../modules/azure/azure-blob-storage-connector.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index 7bff6efb018..7ba894f908e 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -1,12 +1,8 @@ --- title: "Azure Blob Storage" -url: /appstore/modules/azure/azure-blob-storage/ +url: /appstore/azure-modules/azure-blob-storage/ 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." weight: 20 -aliases: - - /appstore/connectors/azure-blob-storage-connector/ - - /appstore/connectors/azure/azure-blob-storage/ -#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. --- ## Introduction From 6dc9906895c34c0d95344318fc94d942901f7370 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Tue, 15 Jul 2025 15:33:54 +0200 Subject: [PATCH 04/13] Update azure-blob-storage-connector.md --- .../modules/azure/azure-blob-storage-connector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index 7ba894f908e..b86caf9cbf7 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -1,5 +1,5 @@ --- -title: "Azure Blob Storage" +title: "Azure Blob Storage Connector" url: /appstore/azure-modules/azure-blob-storage/ 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." weight: 20 From 29a0ea48a68a59b0c7379ef6f3f7f076fd301467 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:24:46 +0200 Subject: [PATCH 05/13] Update azure-blob-storage-connector.md --- .../modules/azure/azure-blob-storage-connector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index b86caf9cbf7..72296b2aee6 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -99,7 +99,7 @@ For additional reference, the available activities are listed below. ### Operations -[Operations](/refguide/Operations/) define the operations that are executed in a microflow or a nanoflow. +[Operations](/refguide/operations/) define the operations that are executed in a microflow or a nanoflow. The Azure Blob Storage connector contains the following activities: From d0457bc7e5eb59070c98a72db6fa6700783b84b5 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:57:26 +0200 Subject: [PATCH 06/13] Update azure-blob-storage-connector.md --- .../modules/azure/azure-blob-storage-connector.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index 72296b2aee6..d4e06d3c411 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -36,16 +36,18 @@ After you install the connector, you can find it in the **App Explorer**, in the ### Configuring Authentication {#authentication} -To interact with Azure Blob Storage, authentication can be performed using either a Shared Access Signature (SAS) or an Azure Entra ID Access Token. +To interact with Azure Blob Storage, authentication can be done using either a Shared Access Signature (SAS) or an Azure Entra ID Access Token. + +#### Configuring SAS Authorization -#### SAS authorization A Shared Access Signature (SAS) provides secure, delegated access to resources in your storage account. Follow these steps: 1. Have your administrator generate a SAS for the target container or blob 2. Create a `SASCredentials` object and populate its `SASToken` attribute 3. Pass the `SASCredentials` object to the `AbstractCredentials` parameter in your operation microflow -#### Azure Entra ID Access Token +#### Configuring an Azure Entra ID Access Token + For Azure Entra ID authentication: 1. Configure Single Sign-On (SSO) using the `OIDC SSO` marketplace module From dfcda9744e98e09498644d4ae661b8781097ca28 Mon Sep 17 00:00:00 2001 From: strategicalliances <139855197+strategicalliances@users.noreply.github.com> Date: Thu, 24 Jul 2025 12:04:43 +0200 Subject: [PATCH 07/13] Update azure-blob-storage-connector.md Documentation updated to reflect the first release version without Delete and List operations --- .../azure/azure-blob-storage-connector.md | 38 ------------------- 1 file changed, 38 deletions(-) diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md index 2b2a4440476..5405e540c50 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -73,8 +73,6 @@ The Azure Blob Storage connector contains the following operations: * `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). * `GetBlob` - Allows you to retrieve a Blob. For more information, see [Get Blob to Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). -* `DeleteBlob` - Allows you to delete a Blob. For more information, see [Delete Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). -* `ListBlobs` - Allows you to list the Blobs in a speciefied container. For more information, see [List Blobs from a Azure Blob Storage container](https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs?tabs=microsoft-entra-id). * `GetApplicationBearerToken` - Allows the application to request a bearer token. The response is mapped to a `EntraCredentials` object that can be used to authenticate calls to Blob Storage. You can implement the operations of the connector by using them in microflows. @@ -131,42 +129,6 @@ To use this operation in your microflow: 3. Call the `GET_v1_Azure_GetBlob` action in your microflow. 4. The operation returns a Mendix `FileDocument` object containing the blob data. -#### DELETE_v1_Azure_DeleteBlob - -* `DeleteBlob` – Deletes a specified blob from Azure Blob Storage. This operation requires a valid `DeleteBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Delete Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). - -To use the DeleteBlob operation in your microflow: - -1. Create a `DeleteBlobRequest` object and populate the required attributes: - - | Parameter | Description | Required | - |------------------|--------------------------------------------------------------|----------| - | `BlobName` | Name of the blob to delete | Yes | - | `ContainerName` | Name of the container where the blob is stored | Yes | - -2. Provide a valid credentials object via the `AbstractCredentials` parameter. -3. Call the `DELETE_v1_Azure_DeleteBlob` action in your microflow. -4. The operation returns a `DeleteBlobResponse` object, which is a generalization of `AbstractResponse` and contains the StatusCode and ReasonPhrase. - -#### GET_v1_Azure_ListBlobs - -* `ListBlobs` – Lists the blobs contained in your specified Azure Blob Storage container. This operation requires a valid `ListBlobsRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [List Blobs from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs). - -To use the ListBlobs operation in your microflow: - -1. Create a `ListBlobsRequest` object and populate the required attributes: - - | Parameter | Description | Required | - |------------------|--------------------------------------------------------------|----------| - | `ContainerName` | Name of the container where the blob is stored | Yes | - | `Prefix` | The prefix attribute is used to only list Blobsfrom from a folder within your container with the specified prefix | No | - | `MaxResults` | The max amount of results listed by the LisBlobs operaration | No | - | `ContainerName` | The marker used to get the next (sub)set of blobs from the specified location. | No | - -3. Provide a valid credentials object via the `AbstractCredentials` parameter. -4. Call the `GET_v1_Azure_ListBlobs` action in your microflow. -5. The operation returns a list of `Blob` objects associated to the `ListBlobResponse`, which is a generalization of `AbstractResponse` and contains the StatusCode and ReasonPhrase. - ## Technical Reference {#technical-reference} 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. From 36ac992c136b704fac270c052a24d5d506baf017 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Thu, 24 Jul 2025 14:44:24 +0200 Subject: [PATCH 08/13] sme updates --- .../azure/azure-blob-storage-connector.md | 79 +++++++++++++------ 1 file changed, 54 insertions(+), 25 deletions(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index d4e06d3c411..8224dc9d89a 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -36,37 +36,57 @@ After you install the connector, you can find it in the **App Explorer**, in the ### Configuring Authentication {#authentication} -To interact with Azure Blob Storage, authentication can be done using either a Shared Access Signature (SAS) or an Azure Entra ID Access Token. - -#### Configuring SAS Authorization +To interact with Azure Blob Storage, authentication can be performed using either a Shared Access Signature (SAS) or an Azure Entra ID Access Token. +#### SAS authorization A Shared Access Signature (SAS) provides secure, delegated access to resources in your storage account. Follow these steps: 1. Have your administrator generate a SAS for the target container or blob 2. Create a `SASCredentials` object and populate its `SASToken` attribute 3. Pass the `SASCredentials` object to the `AbstractCredentials` parameter in your operation microflow -#### Configuring an Azure Entra ID Access Token - -For Azure Entra ID authentication: +#### User Based Azure Entra ID Access Token +For user based Azure Entra ID authentication: 1. Configure Single Sign-On (SSO) using the `OIDC SSO` marketplace module 2. Utilize the `GetCurrentToken` microflow to obtain the required access token 3. Create an `EntraCredentials` object and set its `BearerToken` attribute 4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow -### Configuring a Microflow for an AWS Service +#### Application Based Azure Entra ID Access Token +For application based Azure Entra ID authentication: + +1. Set the ClientId, ClientSecret and TenantId constants of your registered application in Azure +2. Create a `GetApplicationBearerTokenRequest` object +3. Supply the `GetApplicationBearerTokenRequest` to the `POST_v1_Azure_GetApplicationBearerToken` operation to generate a token and return an `EntraCredentials` object +4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow + +### Configuring Operation Microflows + +[Operations](/refguide/Operations/) define the operations that are executed in a microflow or a nanoflow. + +The Azure Blob Storage connector contains the following operations: -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: +* `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). +* `GetBlob` - Allows you to retrieve a Blob. For more information, see [Get Blob to Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). +* `GetApplicationBearerToken` - Allows the application to request a bearer token. The response is mapped to a `EntraCredentials` object that can be used to authenticate calls to Blob Storage. + +You can implement the operations of the connector by using them in microflows. + +#### PUT_v1_Azure_PutBlob + +`PutBlob` – stores the contents of a document as a blob in Azure Blob Storage. This operation requires a valid `PutBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Put Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob). + +To use this operation in your microflow: 1. In the **App Explorer**, right-click on the name of your module, and then click **Add microflow**. 2. Enter a name for your microflow, for example, *ACT_PutBlob*, and then click **OK**. 3. In the **App Explorer**, in the **AzureBlobStorageConnector** section, find the **PUT_v1_Azure_PutBlob** operation microflow. -4. Create a **SASCredentials** or **EntrCredentials** object and add the SAS or access token to the **SASToken** or **BearerToken** attribute. +4. Create a **SASCredentials** or **EntraCredentials** object and add the SAS or access token to the **SASToken** or **BearerToken** attribute. 5. Drag the **PUT_v1_Azure_PutBlob** microflow in to your microflow. 6. Double-click the **PUT_v1_Azure_PutBlob** operation to configure the required parameters. - - For the `PUT_v1_Azure_PutBlob` operation, retrieve the `System.FileDocument` you want to store and provide a configured `SASCredentials` or `EntrCredentials` object. You must then create a `PutBlobRequest` object in your microflow as the last parameter. This entity requires the following parameters: + + For the `PUT_v1_Azure_PutBlob` operation, retrieve the `System.FileDocument` you want to store and provide a configured `SASCredentials` or `EntraCredentials` object. You must then create a `PutBlobRequest` object in your microflow as the last parameter. This entity requires the following parameters: | Parameter | Description | Required | |-----------|-------------|----------| @@ -82,27 +102,36 @@ You can implement the operations of the connector by using them in microflows. F |-----------|-------------|----------| | `ContentType` | MIME content type specification | application/octet-stream | | `StorageType` | Storage tier configuration | Varies by blob type | - -9. Configure a method to trigger the `ACT_PutBlob` microflow. + +7. Configure a method to trigger the `ACT_PutBlob` microflow. 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/). - -## Technical Reference {#technical-reference} -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. +#### GET_v1_Azure_GetBlob -The **Documentation** pane displays the documentation for the currently selected element. To view it, perform the following steps: +`GetBlob` – Retrieves the contents of a blob stored in Azure Blob Storage. This operation requires a valid `GetBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Get Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). -1. In the [View menu](/refguide/view-menu/) of Studio Pro, select **Documentation**. -2. Click on the element for which you want to view the documentation. +To use this operation in your microflow: - {{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" class="no-border" >}} +1. Create a `GetBlobRequest` object and populate the required attributes: -For additional reference, the available activities are listed below. + | Parameter | Description | Required | + |------------------|--------------------------------------------------------------|----------| + | `BlobName` | Name of the blob to retrieve | Yes | + | `ContainerName` | Name of the container the blob is stored in | Yes | + | `BlobType` | Type of blob (currently supports BlockBlob only) | Yes | + | `ContentType` | MIME content type of the blob (used for response header) | No | -### Operations +2. Provide a valid credentials object via the `AbstractCredentials` parameter. +3. Call the `GET_v1_Azure_GetBlob` action in your microflow. +4. The operation returns a Mendix `FileDocument` object containing the blob data. -[Operations](/refguide/operations/) define the operations that are executed in a microflow or a nanoflow. +## Technical Reference {#technical-reference} -The Azure Blob Storage connector contains the following activities: +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. -* `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). +The **Documentation** pane displays the documentation for the currently selected element. To view it, perform the following steps: + +1. In the [View menu](/refguide/view-menu/) of Studio Pro, select **Documentation**. +2. Click on the element for which you want to view the documentation. + + {{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" class="no-border" >}} \ No newline at end of file From 272dabc2fc2c37ffa375c40997cb19713d88a71e Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Thu, 24 Jul 2025 14:46:10 +0200 Subject: [PATCH 09/13] removed file with the wrong path --- .../azure/azure-blob-storage-connector.md | 141 ------------------ 1 file changed, 141 deletions(-) delete mode 100644 content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md deleted file mode 100644 index 5405e540c50..00000000000 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: "Azure Blob Storage" -url: /appstore/modules/azure/azure-blob-storage/ -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." -weight: 20 -aliases: - - /appstore/connectors/azure-blob-storage-connector/ - - /appstore/connectors/azure/azure-blob-storage/ -#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. ---- - -## Introduction - -The [Azure Blob Storage](https://marketplace.mendix.com/link/component/) connector enables you to connect your app to [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs) and easily store objects. - -### Typical Use Cases - -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: - -* 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. -* Archive data at the lowest cost - Move data archives to the Azure Blob Storage to eliminate operational complexities, and gain new insights. - -### Prerequisites {#prerequisites} - -The Azure Blob Storage Connector requires Mendix Studio Pro version 9.24.2 or above. - -### Licensing and Cost - -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. - -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/). - -## Installation - -Follow the instructions in [How to Use Marketplace Content](/appstore/use-content/) to import the Azure Blob Storage connector into your app. - -## Configuration - -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. - -### Configuring Authentication {#authentication} - -To interact with Azure Blob Storage, authentication can be performed using either a Shared Access Signature (SAS) or an Azure Entra ID Access Token. - -#### SAS authorization -A Shared Access Signature (SAS) provides secure, delegated access to resources in your storage account. Follow these steps: - -1. Have your administrator generate a SAS for the target container or blob -2. Create a `SASCredentials` object and populate its `SASToken` attribute -3. Pass the `SASCredentials` object to the `AbstractCredentials` parameter in your operation microflow - -#### User Based Azure Entra ID Access Token -For user based Azure Entra ID authentication: - -1. Configure Single Sign-On (SSO) using the `OIDC SSO` marketplace module -2. Utilize the `GetCurrentToken` microflow to obtain the required access token -3. Create an `EntraCredentials` object and set its `BearerToken` attribute -4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow - -#### Application Based Azure Entra ID Access Token -For application based Azure Entra ID authentication: - -1. Set the ClientId, ClientSecret and TenantId constants of your registered application in Azure -2. Create a `GetApplicationBearerTokenRequest` object -3. Supply the `GetApplicationBearerTokenRequest` to the `POST_v1_Azure_GetApplicationBearerToken` operation to generate a token and return an `EntraCredentials` object -4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow - -### Configuring Operation Microflows - -[Operations](/refguide/Operations/) define the operations that are executed in a microflow or a nanoflow. - -The Azure Blob Storage connector contains the following operations: - -* `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). -* `GetBlob` - Allows you to retrieve a Blob. For more information, see [Get Blob to Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). -* `GetApplicationBearerToken` - Allows the application to request a bearer token. The response is mapped to a `EntraCredentials` object that can be used to authenticate calls to Blob Storage. - -You can implement the operations of the connector by using them in microflows. - -#### PUT_v1_Azure_PutBlob - -`PutBlob` – stores the contents of a document as a blob in Azure Blob Storage. This operation requires a valid `PutBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Put Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob). - -To use this operation in your microflow: - -1. In the **App Explorer**, right-click on the name of your module, and then click **Add microflow**. -2. Enter a name for your microflow, for example, *ACT_PutBlob*, and then click **OK**. -3. In the **App Explorer**, in the **AzureBlobStorageConnector** section, find the **PUT_v1_Azure_PutBlob** operation microflow. -4. Create a **SASCredentials** or **EntraCredentials** object and add the SAS or access token to the **SASToken** or **BearerToken** attribute. -5. Drag the **PUT_v1_Azure_PutBlob** microflow in to your microflow. -6. Double-click the **PUT_v1_Azure_PutBlob** operation to configure the required parameters. - - For the `PUT_v1_Azure_PutBlob` operation, retrieve the `System.FileDocument` you want to store and provide a configured `SASCredentials` or `EntraCredentials` object. You must then create a `PutBlobRequest` object in your microflow as the last parameter. This entity requires the following parameters: - - | Parameter | Description | Required | - |-----------|-------------|----------| - | `StorageAccount` | Storage account name you want to perform Blob storage operations on | Yes | - | `VersionAPI` | API version for the Azure Storage service (e.g., '2021-04-01') | Yes | - | `BlobName` | Desired name for the blob in storage | Yes | - | `ContainerName` | Target container for blob storage | Yes | - | `BlobType` | Type of blob (currently supports BlockBlob only) | Yes | - - The following parameters are optional: - - | Parameter | Description | Default | - |-----------|-------------|----------| - | `ContentType` | MIME content type specification | application/octet-stream | - | `StorageType` | Storage tier configuration | Varies by blob type | - -7. Configure a method to trigger the `ACT_PutBlob` microflow. - 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/). - -#### GET_v1_Azure_GetBlob - -`GetBlob` – Retrieves the contents of a blob stored in Azure Blob Storage. This operation requires a valid `GetBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Get Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). - -To use this operation in your microflow: - -1. Create a `GetBlobRequest` object and populate the required attributes: - - | Parameter | Description | Required | - |------------------|--------------------------------------------------------------|----------| - | `BlobName` | Name of the blob to retrieve | Yes | - | `ContainerName` | Name of the container the blob is stored in | Yes | - | `BlobType` | Type of blob (currently supports BlockBlob only) | Yes | - | `ContentType` | MIME content type of the blob (used for response header) | No | - -2. Provide a valid credentials object via the `AbstractCredentials` parameter. -3. Call the `GET_v1_Azure_GetBlob` action in your microflow. -4. The operation returns a Mendix `FileDocument` object containing the blob data. - -## Technical Reference {#technical-reference} - -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. - -The **Documentation** pane displays the documentation for the currently selected element. To view it, perform the following steps: - -1. In the [View menu](/refguide/view-menu/) of Studio Pro, select **Documentation**. -2. Click on the element for which you want to view the documentation. - - {{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" class="no-border" >}} From d7f159017c16f328d724d14417374e73a6a3c552 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Thu, 24 Jul 2025 15:33:14 +0200 Subject: [PATCH 10/13] edits --- .../azure/azure-blob-storage-connector.md | 72 ++++++++++--------- 1 file changed, 38 insertions(+), 34 deletions(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index 8224dc9d89a..cbd7bbd8b7f 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -13,7 +13,7 @@ The [Azure Blob Storage](https://marketplace.mendix.com/link/component/ Date: Wed, 30 Jul 2025 15:33:24 +0200 Subject: [PATCH 11/13] Revert "Revert "Strategicalliances azure blob storage v2"" --- .../azure/azure-blob-storage-connector.md | 179 ++++++++++++++++++ 1 file changed, 179 insertions(+) create mode 100644 content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md new file mode 100644 index 00000000000..2b2a4440476 --- /dev/null +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -0,0 +1,179 @@ +--- +title: "Azure Blob Storage" +url: /appstore/modules/azure/azure-blob-storage/ +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." +weight: 20 +aliases: + - /appstore/connectors/azure-blob-storage-connector/ + - /appstore/connectors/azure/azure-blob-storage/ +#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. +--- + +## Introduction + +The [Azure Blob Storage](https://marketplace.mendix.com/link/component/) connector enables you to connect your app to [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs) and easily store objects. + +### Typical Use Cases + +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: + +* 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. +* Archive data at the lowest cost - Move data archives to the Azure Blob Storage to eliminate operational complexities, and gain new insights. + +### Prerequisites {#prerequisites} + +The Azure Blob Storage Connector requires Mendix Studio Pro version 9.24.2 or above. + +### Licensing and Cost + +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. + +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/). + +## Installation + +Follow the instructions in [How to Use Marketplace Content](/appstore/use-content/) to import the Azure Blob Storage connector into your app. + +## Configuration + +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. + +### Configuring Authentication {#authentication} + +To interact with Azure Blob Storage, authentication can be performed using either a Shared Access Signature (SAS) or an Azure Entra ID Access Token. + +#### SAS authorization +A Shared Access Signature (SAS) provides secure, delegated access to resources in your storage account. Follow these steps: + +1. Have your administrator generate a SAS for the target container or blob +2. Create a `SASCredentials` object and populate its `SASToken` attribute +3. Pass the `SASCredentials` object to the `AbstractCredentials` parameter in your operation microflow + +#### User Based Azure Entra ID Access Token +For user based Azure Entra ID authentication: + +1. Configure Single Sign-On (SSO) using the `OIDC SSO` marketplace module +2. Utilize the `GetCurrentToken` microflow to obtain the required access token +3. Create an `EntraCredentials` object and set its `BearerToken` attribute +4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow + +#### Application Based Azure Entra ID Access Token +For application based Azure Entra ID authentication: + +1. Set the ClientId, ClientSecret and TenantId constants of your registered application in Azure +2. Create a `GetApplicationBearerTokenRequest` object +3. Supply the `GetApplicationBearerTokenRequest` to the `POST_v1_Azure_GetApplicationBearerToken` operation to generate a token and return an `EntraCredentials` object +4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow + +### Configuring Operation Microflows + +[Operations](/refguide/Operations/) define the operations that are executed in a microflow or a nanoflow. + +The Azure Blob Storage connector contains the following operations: + +* `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). +* `GetBlob` - Allows you to retrieve a Blob. For more information, see [Get Blob to Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). +* `DeleteBlob` - Allows you to delete a Blob. For more information, see [Delete Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). +* `ListBlobs` - Allows you to list the Blobs in a speciefied container. For more information, see [List Blobs from a Azure Blob Storage container](https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs?tabs=microsoft-entra-id). +* `GetApplicationBearerToken` - Allows the application to request a bearer token. The response is mapped to a `EntraCredentials` object that can be used to authenticate calls to Blob Storage. + +You can implement the operations of the connector by using them in microflows. + +#### PUT_v1_Azure_PutBlob + +`PutBlob` – stores the contents of a document as a blob in Azure Blob Storage. This operation requires a valid `PutBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Put Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob). + +To use this operation in your microflow: + +1. In the **App Explorer**, right-click on the name of your module, and then click **Add microflow**. +2. Enter a name for your microflow, for example, *ACT_PutBlob*, and then click **OK**. +3. In the **App Explorer**, in the **AzureBlobStorageConnector** section, find the **PUT_v1_Azure_PutBlob** operation microflow. +4. Create a **SASCredentials** or **EntraCredentials** object and add the SAS or access token to the **SASToken** or **BearerToken** attribute. +5. Drag the **PUT_v1_Azure_PutBlob** microflow in to your microflow. +6. Double-click the **PUT_v1_Azure_PutBlob** operation to configure the required parameters. + + For the `PUT_v1_Azure_PutBlob` operation, retrieve the `System.FileDocument` you want to store and provide a configured `SASCredentials` or `EntraCredentials` object. You must then create a `PutBlobRequest` object in your microflow as the last parameter. This entity requires the following parameters: + + | Parameter | Description | Required | + |-----------|-------------|----------| + | `StorageAccount` | Storage account name you want to perform Blob storage operations on | Yes | + | `VersionAPI` | API version for the Azure Storage service (e.g., '2021-04-01') | Yes | + | `BlobName` | Desired name for the blob in storage | Yes | + | `ContainerName` | Target container for blob storage | Yes | + | `BlobType` | Type of blob (currently supports BlockBlob only) | Yes | + + The following parameters are optional: + + | Parameter | Description | Default | + |-----------|-------------|----------| + | `ContentType` | MIME content type specification | application/octet-stream | + | `StorageType` | Storage tier configuration | Varies by blob type | + +7. Configure a method to trigger the `ACT_PutBlob` microflow. + 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/). + +#### GET_v1_Azure_GetBlob + +`GetBlob` – Retrieves the contents of a blob stored in Azure Blob Storage. This operation requires a valid `GetBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Get Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). + +To use this operation in your microflow: + +1. Create a `GetBlobRequest` object and populate the required attributes: + + | Parameter | Description | Required | + |------------------|--------------------------------------------------------------|----------| + | `BlobName` | Name of the blob to retrieve | Yes | + | `ContainerName` | Name of the container the blob is stored in | Yes | + | `BlobType` | Type of blob (currently supports BlockBlob only) | Yes | + | `ContentType` | MIME content type of the blob (used for response header) | No | + +2. Provide a valid credentials object via the `AbstractCredentials` parameter. +3. Call the `GET_v1_Azure_GetBlob` action in your microflow. +4. The operation returns a Mendix `FileDocument` object containing the blob data. + +#### DELETE_v1_Azure_DeleteBlob + +* `DeleteBlob` – Deletes a specified blob from Azure Blob Storage. This operation requires a valid `DeleteBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Delete Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). + +To use the DeleteBlob operation in your microflow: + +1. Create a `DeleteBlobRequest` object and populate the required attributes: + + | Parameter | Description | Required | + |------------------|--------------------------------------------------------------|----------| + | `BlobName` | Name of the blob to delete | Yes | + | `ContainerName` | Name of the container where the blob is stored | Yes | + +2. Provide a valid credentials object via the `AbstractCredentials` parameter. +3. Call the `DELETE_v1_Azure_DeleteBlob` action in your microflow. +4. The operation returns a `DeleteBlobResponse` object, which is a generalization of `AbstractResponse` and contains the StatusCode and ReasonPhrase. + +#### GET_v1_Azure_ListBlobs + +* `ListBlobs` – Lists the blobs contained in your specified Azure Blob Storage container. This operation requires a valid `ListBlobsRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [List Blobs from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs). + +To use the ListBlobs operation in your microflow: + +1. Create a `ListBlobsRequest` object and populate the required attributes: + + | Parameter | Description | Required | + |------------------|--------------------------------------------------------------|----------| + | `ContainerName` | Name of the container where the blob is stored | Yes | + | `Prefix` | The prefix attribute is used to only list Blobsfrom from a folder within your container with the specified prefix | No | + | `MaxResults` | The max amount of results listed by the LisBlobs operaration | No | + | `ContainerName` | The marker used to get the next (sub)set of blobs from the specified location. | No | + +3. Provide a valid credentials object via the `AbstractCredentials` parameter. +4. Call the `GET_v1_Azure_ListBlobs` action in your microflow. +5. The operation returns a list of `Blob` objects associated to the `ListBlobResponse`, which is a generalization of `AbstractResponse` and contains the StatusCode and ReasonPhrase. + +## Technical Reference {#technical-reference} + +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. + +The **Documentation** pane displays the documentation for the currently selected element. To view it, perform the following steps: + +1. In the [View menu](/refguide/view-menu/) of Studio Pro, select **Documentation**. +2. Click on the element for which you want to view the documentation. + + {{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" class="no-border" >}} From da6bcb17c263dc468e648344eea374cfc0f9d709 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Wed, 30 Jul 2025 15:40:14 +0200 Subject: [PATCH 12/13] reconciling changes from the developers' fork --- .../azure/azure-blob-storage-connector.md | 179 ------------------ .../azure/azure-blob-storage-connector.md | 126 +++++++----- 2 files changed, 82 insertions(+), 223 deletions(-) delete mode 100644 content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md deleted file mode 100644 index 2b2a4440476..00000000000 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -title: "Azure Blob Storage" -url: /appstore/modules/azure/azure-blob-storage/ -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." -weight: 20 -aliases: - - /appstore/connectors/azure-blob-storage-connector/ - - /appstore/connectors/azure/azure-blob-storage/ -#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. ---- - -## Introduction - -The [Azure Blob Storage](https://marketplace.mendix.com/link/component/) connector enables you to connect your app to [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs) and easily store objects. - -### Typical Use Cases - -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: - -* 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. -* Archive data at the lowest cost - Move data archives to the Azure Blob Storage to eliminate operational complexities, and gain new insights. - -### Prerequisites {#prerequisites} - -The Azure Blob Storage Connector requires Mendix Studio Pro version 9.24.2 or above. - -### Licensing and Cost - -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. - -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/). - -## Installation - -Follow the instructions in [How to Use Marketplace Content](/appstore/use-content/) to import the Azure Blob Storage connector into your app. - -## Configuration - -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. - -### Configuring Authentication {#authentication} - -To interact with Azure Blob Storage, authentication can be performed using either a Shared Access Signature (SAS) or an Azure Entra ID Access Token. - -#### SAS authorization -A Shared Access Signature (SAS) provides secure, delegated access to resources in your storage account. Follow these steps: - -1. Have your administrator generate a SAS for the target container or blob -2. Create a `SASCredentials` object and populate its `SASToken` attribute -3. Pass the `SASCredentials` object to the `AbstractCredentials` parameter in your operation microflow - -#### User Based Azure Entra ID Access Token -For user based Azure Entra ID authentication: - -1. Configure Single Sign-On (SSO) using the `OIDC SSO` marketplace module -2. Utilize the `GetCurrentToken` microflow to obtain the required access token -3. Create an `EntraCredentials` object and set its `BearerToken` attribute -4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow - -#### Application Based Azure Entra ID Access Token -For application based Azure Entra ID authentication: - -1. Set the ClientId, ClientSecret and TenantId constants of your registered application in Azure -2. Create a `GetApplicationBearerTokenRequest` object -3. Supply the `GetApplicationBearerTokenRequest` to the `POST_v1_Azure_GetApplicationBearerToken` operation to generate a token and return an `EntraCredentials` object -4. Supply the `EntraCredentials` object to the `AbstractCredentials` parameter in your operation microflow - -### Configuring Operation Microflows - -[Operations](/refguide/Operations/) define the operations that are executed in a microflow or a nanoflow. - -The Azure Blob Storage connector contains the following operations: - -* `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). -* `GetBlob` - Allows you to retrieve a Blob. For more information, see [Get Blob to Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). -* `DeleteBlob` - Allows you to delete a Blob. For more information, see [Delete Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). -* `ListBlobs` - Allows you to list the Blobs in a speciefied container. For more information, see [List Blobs from a Azure Blob Storage container](https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs?tabs=microsoft-entra-id). -* `GetApplicationBearerToken` - Allows the application to request a bearer token. The response is mapped to a `EntraCredentials` object that can be used to authenticate calls to Blob Storage. - -You can implement the operations of the connector by using them in microflows. - -#### PUT_v1_Azure_PutBlob - -`PutBlob` – stores the contents of a document as a blob in Azure Blob Storage. This operation requires a valid `PutBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Put Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob). - -To use this operation in your microflow: - -1. In the **App Explorer**, right-click on the name of your module, and then click **Add microflow**. -2. Enter a name for your microflow, for example, *ACT_PutBlob*, and then click **OK**. -3. In the **App Explorer**, in the **AzureBlobStorageConnector** section, find the **PUT_v1_Azure_PutBlob** operation microflow. -4. Create a **SASCredentials** or **EntraCredentials** object and add the SAS or access token to the **SASToken** or **BearerToken** attribute. -5. Drag the **PUT_v1_Azure_PutBlob** microflow in to your microflow. -6. Double-click the **PUT_v1_Azure_PutBlob** operation to configure the required parameters. - - For the `PUT_v1_Azure_PutBlob` operation, retrieve the `System.FileDocument` you want to store and provide a configured `SASCredentials` or `EntraCredentials` object. You must then create a `PutBlobRequest` object in your microflow as the last parameter. This entity requires the following parameters: - - | Parameter | Description | Required | - |-----------|-------------|----------| - | `StorageAccount` | Storage account name you want to perform Blob storage operations on | Yes | - | `VersionAPI` | API version for the Azure Storage service (e.g., '2021-04-01') | Yes | - | `BlobName` | Desired name for the blob in storage | Yes | - | `ContainerName` | Target container for blob storage | Yes | - | `BlobType` | Type of blob (currently supports BlockBlob only) | Yes | - - The following parameters are optional: - - | Parameter | Description | Default | - |-----------|-------------|----------| - | `ContentType` | MIME content type specification | application/octet-stream | - | `StorageType` | Storage tier configuration | Varies by blob type | - -7. Configure a method to trigger the `ACT_PutBlob` microflow. - 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/). - -#### GET_v1_Azure_GetBlob - -`GetBlob` – Retrieves the contents of a blob stored in Azure Blob Storage. This operation requires a valid `GetBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Get Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob). - -To use this operation in your microflow: - -1. Create a `GetBlobRequest` object and populate the required attributes: - - | Parameter | Description | Required | - |------------------|--------------------------------------------------------------|----------| - | `BlobName` | Name of the blob to retrieve | Yes | - | `ContainerName` | Name of the container the blob is stored in | Yes | - | `BlobType` | Type of blob (currently supports BlockBlob only) | Yes | - | `ContentType` | MIME content type of the blob (used for response header) | No | - -2. Provide a valid credentials object via the `AbstractCredentials` parameter. -3. Call the `GET_v1_Azure_GetBlob` action in your microflow. -4. The operation returns a Mendix `FileDocument` object containing the blob data. - -#### DELETE_v1_Azure_DeleteBlob - -* `DeleteBlob` – Deletes a specified blob from Azure Blob Storage. This operation requires a valid `DeleteBlobRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [Delete Blob from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). - -To use the DeleteBlob operation in your microflow: - -1. Create a `DeleteBlobRequest` object and populate the required attributes: - - | Parameter | Description | Required | - |------------------|--------------------------------------------------------------|----------| - | `BlobName` | Name of the blob to delete | Yes | - | `ContainerName` | Name of the container where the blob is stored | Yes | - -2. Provide a valid credentials object via the `AbstractCredentials` parameter. -3. Call the `DELETE_v1_Azure_DeleteBlob` action in your microflow. -4. The operation returns a `DeleteBlobResponse` object, which is a generalization of `AbstractResponse` and contains the StatusCode and ReasonPhrase. - -#### GET_v1_Azure_ListBlobs - -* `ListBlobs` – Lists the blobs contained in your specified Azure Blob Storage container. This operation requires a valid `ListBlobsRequest` object and an appropriate credentials object (either `SASCredentials` or `EntraCredentials`). For more information, see [List Blobs from Azure Blob Storage](https://learn.microsoft.com/en-us/rest/api/storageservices/list-blobs). - -To use the ListBlobs operation in your microflow: - -1. Create a `ListBlobsRequest` object and populate the required attributes: - - | Parameter | Description | Required | - |------------------|--------------------------------------------------------------|----------| - | `ContainerName` | Name of the container where the blob is stored | Yes | - | `Prefix` | The prefix attribute is used to only list Blobsfrom from a folder within your container with the specified prefix | No | - | `MaxResults` | The max amount of results listed by the LisBlobs operaration | No | - | `ContainerName` | The marker used to get the next (sub)set of blobs from the specified location. | No | - -3. Provide a valid credentials object via the `AbstractCredentials` parameter. -4. Call the `GET_v1_Azure_ListBlobs` action in your microflow. -5. The operation returns a list of `Blob` objects associated to the `ListBlobResponse`, which is a generalization of `AbstractResponse` and contains the StatusCode and ReasonPhrase. - -## Technical Reference {#technical-reference} - -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. - -The **Documentation** pane displays the documentation for the currently selected element. To view it, perform the following steps: - -1. In the [View menu](/refguide/view-menu/) of Studio Pro, select **Documentation**. -2. Click on the element for which you want to view the documentation. - - {{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" class="no-border" >}} diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index cbd7bbd8b7f..2b2a4440476 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -1,8 +1,12 @@ --- -title: "Azure Blob Storage Connector" -url: /appstore/azure-modules/azure-blob-storage/ +title: "Azure Blob Storage" +url: /appstore/modules/azure/azure-blob-storage/ 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." weight: 20 +aliases: + - /appstore/connectors/azure-blob-storage-connector/ + - /appstore/connectors/azure/azure-blob-storage/ +#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. --- ## Introduction @@ -13,7 +17,7 @@ The [Azure Blob Storage](https://marketplace.mendix.com/link/component/}} \ No newline at end of file + {{< figure src="/attachments/appstore/platform-supported-content/modules/technical-reference/doc-pane.png" class="no-border" >}} From ebbfce192005c96bac6428999d49beb821629af1 Mon Sep 17 00:00:00 2001 From: katarzyna-koltun-mx <108737161+katarzyna-koltun-mx@users.noreply.github.com> Date: Wed, 30 Jul 2025 15:56:26 +0200 Subject: [PATCH 13/13] Update azure-blob-storage-connector.md --- .../azure/azure-blob-storage-connector.md | 125 +++++++++--------- 1 file changed, 62 insertions(+), 63 deletions(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md index 2b2a4440476..fd36a2039dd 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md @@ -1,12 +1,8 @@ --- -title: "Azure Blob Storage" -url: /appstore/modules/azure/azure-blob-storage/ +title: "Azure Blob Storage Connector" +url: /appstore/azure-modules/azure-blob-storage/ 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." weight: 20 -aliases: - - /appstore/connectors/azure-blob-storage-connector/ - - /appstore/connectors/azure/azure-blob-storage/ -#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. --- ## Introduction @@ -17,7 +13,7 @@ The [Azure Blob Storage](https://marketplace.mendix.com/link/component/