Skip to content

Commit 54fe9f7

Browse files
rwestMSFTrwestMSFT
committed
Refresh SQL Edge articles and clarify EFLOW support
Also remove include file because it's not really being used
1 parent 0c3832e commit 54fe9f7

File tree

4 files changed

+182
-197
lines changed

4 files changed

+182
-197
lines changed

‎articles/azure-sql-edge/deploy-portal.md

Lines changed: 54 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,32 @@ description: Learn how to deploy Azure SQL Edge using the Azure portal
44
author: rwestMSFT
55
ms.author: randolphwest
66
ms.reviewer: kendalv
7-
ms.date: 09/16/2022
7+
ms.date: 01/13/2023
88
ms.service: sql-edge
99
ms.topic: conceptual
1010
keywords: deploy SQL Edge
1111
---
12-
1312
# Deploy Azure SQL Edge
1413

15-
Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] is a relational database engine optimized for IoT and Azure IoT Edge deployments. It provides capabilities to create a high-performance data storage and processing layer for IoT applications and solutions. This quickstart shows you how to get started with creating an Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] module through Azure IoT Edge using the Azure portal.
14+
Azure SQL Edge is a relational database engine optimized for IoT and Azure IoT Edge deployments. It provides capabilities to create a high-performance data storage and processing layer for IoT applications and solutions. This quickstart shows you how to get started with creating an Azure SQL Edge module through Azure IoT Edge using the Azure portal.
1615

1716
## Before you begin
1817

19-
* If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/).
20-
* Sign in to the [Azure portal](https://portal.azure.com/).
21-
* Create an [Azure IoT Hub](../iot-hub/iot-hub-create-through-portal.md).
22-
* Create an [Azure IoT Edge device](../iot-edge/how-to-provision-single-device-linux-symmetric.md).
18+
- If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/).
19+
- Sign in to the [Azure portal](https://portal.azure.com/).
20+
- Create an [Azure IoT Hub](../iot-hub/iot-hub-create-through-portal.md).
21+
- Create an [Azure IoT Edge device](../iot-edge/how-to-provision-single-device-linux-symmetric.md).
2322

2423
> [!NOTE]
2524
> To deploy an Azure Linux VM as an IoT Edge device, see this [quickstart guide](../iot-edge/quickstart-linux.md).
2625
2726
## Deploy SQL Edge Module from Azure Marketplace
2827

29-
Azure Marketplace is an online applications and services marketplace where you can browse through a wide range of enterprise applications and solutions that are certified and optimized to run on Azure, including [IoT Edge modules](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?page=1&subcategories=iot-edge-modules). Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] can be deployed to an edge device through the marketplace.
28+
Azure Marketplace is an online applications and services marketplace where you can browse through a wide range of enterprise applications and solutions that are certified and optimized to run on Azure, including [IoT Edge modules](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?page=1&subcategories=iot-edge-modules). Azure SQL Edge can be deployed to an edge device through the marketplace.
3029

31-
1. Find the Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] module on the Azure Marketplace.
30+
1. Find the Azure SQL Edge module on the Azure Marketplace.
3231

33-
:::image type="content" source="media/deploy-portal/find-offer-marketplace.png" alt-text="Screenshot of SQL Edge in Marketplace.":::
32+
:::image type="content" source="media/deploy-portal/find-offer-marketplace.png" alt-text="Screenshot of SQL Edge in the Azure Marketplace.":::
3433

3534
1. Pick the software plan that best matches your requirements and select **Create**.
3635

@@ -39,25 +38,25 @@ Azure Marketplace is an online applications and services marketplace where you c
3938
1. On the Target Devices for IoT Edge Module page, specify the following details and then select **Create**.
4039

4140
| Field | Description |
42-
|---------|---------|
43-
| **Subscription** | The Azure subscription under which the IoT Hub was created |
44-
| **IoT Hub** | Name of the IoT Hub where the IoT Edge device is registered and then select "Deploy to a device" option |
45-
| **IoT Edge Device Name** | Name of the IoT Edge device where [!INCLUDE [sql-edge](../../includes/sql-edge.md)] would be deployed |
41+
| --- | --- |
42+
| **Subscription** | The Azure subscription under which the IoT Hub was created |
43+
| **IoT Hub** | Name of the IoT Hub where the IoT Edge device is registered and then select "Deploy to a device" option |
44+
| **IoT Edge Device Name** | Name of the IoT Edge device where SQL Edge would be deployed |
4645

47-
1. On the **Set Modules on device:** page, select the Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] module under **IoT Edge Modules**. The default module name is set to *AzureSQLEdge*.
46+
1. On the **Set Modules on device:** page, select the Azure SQL Edge module under **IoT Edge Modules**. The default module name is set to *AzureSQLEdge*.
4847

4948
1. On the *Module Settings* section of the **Update IoT Edge Module** pane, specify the desired values for the *IoT Edge Module Name*, *Restart Policy* and *Desired Status*.
5049

5150
> [!IMPORTANT]
5251
> Don't change or update the **Image URI** settings on the module.
5352
54-
1. On the *Environment Variables* section of the **Update IoT Edge Module** pane, specify the desired values for the environment variables. For a complete list of Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] environment variables, see [Configure using environment variables](configure.md#configure-by-using-environment-variables). The following default environment variables are defined for the module.
53+
1. On the *Environment Variables* section of the **Update IoT Edge Module** pane, specify the desired values for the environment variables. For a complete list of Azure SQL Edge environment variables, see [Configure using environment variables](configure.md#configure-by-using-environment-variables). The following default environment variables are defined for the module.
5554

56-
|**Parameter** |**Description**|
57-
|---------|---------|
58-
| MSSQL_SA_PASSWORD | Change the default value to specify a strong password for the [!INCLUDE [sql-edge](../../includes/sql-edge.md)] admin account. |
59-
| MSSQL_LCID | Change the default value to set the desired language ID to use for [!INCLUDE [sql-edge](../../includes/sql-edge.md)]. For example, 1036 is French. |
60-
| MSSQL_COLLATION | Change the default value to set the default collation for [!INCLUDE [sql-edge](../../includes/sql-edge.md)]. This setting overrides the default mapping of language ID (LCID) to collation. |
55+
| **Parameter** | **Description** |
56+
| --- | --- |
57+
| MSSQL_SA_PASSWORD | Change the default value to specify a strong password for the SQL Edge admin account. |
58+
| MSSQL_LCID | Change the default value to set the desired language ID to use for SQL Edge. For example, 1036 is French. |
59+
| MSSQL_COLLATION | Change the default value to set the default collation for SQL Edge. This setting overrides the default mapping of language ID (LCID) to collation. |
6160

6261
> [!IMPORTANT]
6362
> Don't change or update the `ACCEPT_EULA` environment variable for the module.
@@ -70,42 +69,42 @@ Azure Marketplace is an online applications and services marketplace where you c
7069

7170
- **Binds** and **Mounts**
7271

73-
If you need to deploy more than one [!INCLUDE [sql-edge](../../includes/sql-edge.md)] module, ensure that you update the mounts option to create a new source and target pair for the persistent volume. For more information on mounts and volume, refer [Use volumes](https://docs.docker.com/storage/volumes/) on Docker documentation.
72+
If you need to deploy more than one SQL Edge module, ensure that you update the mounts option to create a new source and target pair for the persistent volume. For more information on mounts and volume, refer [Use volumes](https://docs.docker.com/storage/volumes/) on Docker documentation.
7473

7574
```json
7675
{
77-
"HostConfig": {
78-
"CapAdd": [
79-
"SYS_PTRACE"
80-
],
81-
"Binds": [
82-
"sqlvolume:/sqlvolume"
83-
],
84-
"PortBindings": {
85-
"1433/tcp": [
86-
{
87-
"HostPort": "1433"
88-
}
89-
]
90-
},
91-
"Mounts": [
92-
{
93-
"Type": "volume",
94-
"Source": "sqlvolume",
95-
"Target": "/var/opt/mssql"
96-
}
97-
]
98-
},
99-
"Env": [
100-
"MSSQL_AGENT_ENABLED=TRUE",
101-
"ClientTransportType=AMQP_TCP_Only",
102-
"PlanId=asde-developer-on-iot-edge"
103-
]
76+
"HostConfig": {
77+
"CapAdd": [
78+
"SYS_PTRACE"
79+
],
80+
"Binds": [
81+
"sqlvolume:/sqlvolume"
82+
],
83+
"PortBindings": {
84+
"1433/tcp": [
85+
{
86+
"HostPort": "1433"
87+
}
88+
]
89+
},
90+
"Mounts": [
91+
{
92+
"Type": "volume",
93+
"Source": "sqlvolume",
94+
"Target": "/var/opt/mssql"
95+
}
96+
]
97+
},
98+
"Env": [
99+
"MSSQL_AGENT_ENABLED=TRUE",
100+
"ClientTransportType=AMQP_TCP_Only",
101+
"PlanId=asde-developer-on-iot-edge"
102+
]
104103
}
105104
```
106105

107106
> [!IMPORTANT]
108-
> Do not change the `PlanId` environment variable defined in the create config setting. If this value is changed, the Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] container will fail to start.
107+
> Do not change the `PlanId` environment variable defined in the create config setting. If this value is changed, the Azure SQL Edge container will fail to start.
109108
110109
> [!WARNING]
111110
> If you reinstall the module, remember to remove any existing bindings first, otherwise your environment variables will not be updated.
@@ -116,12 +115,12 @@ Azure Marketplace is an online applications and services marketplace where you c
116115

117116
## Connect to Azure SQL Edge
118117

119-
The following steps use the Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] command-line tool, **sqlcmd**, inside the container to connect to Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)].
118+
The following steps use the Azure SQL Edge command-line tool, **sqlcmd**, inside the container to connect to Azure SQL Edge.
120119

121120
> [!NOTE]
122-
> SQL Server command line tools, including **sqlcmd**, are not available inside the ARM64 version of Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] containers.
121+
> SQL Server command line tools, including **sqlcmd**, are not available inside the ARM64 version of Azure SQL Edge containers.
123122
124-
1. Use the `docker exec -it` command to start an interactive bash shell inside your running container. In the following example `AzureSQLEdge` is name specified by the `Name` parameter of your IoT Edge Module.
123+
1. Use the `docker exec -it` command to start an interactive bash shell inside your running container. In the following example, `AzureSQLEdge` is name specified by the `Name` parameter of your IoT Edge Module.
125124

126125
```bash
127126
sudo docker exec -it AzureSQLEdge "bash"
@@ -216,9 +215,9 @@ Now, run a query to return data from the `Inventory` table.
216215

217216
## Connect from outside the container
218217

219-
You can connect and run SQL queries against your Azure [!INCLUDE [sql-edge](../../includes/sql-edge.md)] instance from any external Linux, Windows, or macOS tool that supports SQL connections. For more information on connecting to a [!INCLUDE [sql-edge](../../includes/sql-edge.md)] container from outside, refer [Connect and Query Azure SQL Edge](./connect.md).
218+
You can connect and run SQL queries against your Azure SQL Edge instance from any external Linux, Windows, or macOS tool that supports SQL connections. For more information on connecting to a SQL Edge container from outside, refer [Connect and Query Azure SQL Edge](./connect.md).
220219

221-
In this quickstart, you deployed a [!INCLUDE [sql-edge](../../includes/sql-edge.md)] Module on an IoT Edge device.
220+
In this quickstart, you deployed a SQL Edge Module on an IoT Edge device.
222221

223222
## Next steps
224223

0 commit comments

Comments
 (0)