microsoft/azure-sql-edge repository overview

⁠Featured Tags

• azure-sql-edge:latest
  docker pull mcr.microsoft.com/azure-sql-edge:latest

⁠About this Image

Official container images for Microsoft Azure SQL Edge for docker engine.

⁠How to use this Image

Start a Azure SQL Edge instance using the latest release

docker run --cap-add SYS_PTRACE -e 'ACCEPT_EULA=1' -e 'MSSQL_SA_PASSWORD=yourStrong(!)Password' -p 1433:1433 --name azuresqledge -d mcr.microsoft.com/azure-sql-edge

Start a Azure SQL Edge instance running as the Premium edition

docker run --cap-add SYS_PTRACE -e 'ACCEPT_EULA=1' -e 'MSSQL_SA_PASSWORD=yourStrong(!)Password' -e 'MSSQL_PID=Premium' -p 1433:1433 --name azuresqledge -d mcr.microsoft.com/azure-sql-edge

Connect to Microsoft Azure SQL Edge

You can connect to Azure SQL Edge instance using the sqlcmd tool inside of the container by using the following command on the host:

docker exec -it <container_id|container_name> /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P <your_password>

You can also use the tools in an entrypoint.sh script to do things like create databases or logins, attach databases, import data, or other setup tasks. See this example of using an entrypoint.sh script to create a database and schema and bcp in some data⁠.

You can connect to the Azure SQL Edge instance in the container from outside the container by using various command line and GUI tools on the host or remote computers. See the Connect and Query⁠ topic in the Azure SQL Edge documentation.

⁠Configuration

⁠Requirements

• This image requires Docker Engine 1.8+ in any of their supported platforms⁠.

• At least 1GB of RAM. Make sure to assign enough memory to the Docker VM if you're running on Docker for Mac⁠ or Windows⁠.

• Requires the following environment flags

  ACCEPT_EULA=Y

  MSSQL_SA_PASSWORD=<your_strong_password>

  MSSQL_PID=<edition_name> (default: Developer)

• A strong system administrator (SA) password: At least 8 characters including uppercase, lowercase letters, base-10 digits and/or non-alphanumeric symbols.

⁠Environment Variables

You can use environment variables⁠ or mssql.conf file⁠ to configure Azure SQL Edge Containers

ACCEPT_EULA confirms your acceptance of the End-User Licensing Terms. For the Azure SQL Edge Developer EULA can be located here⁠. Azure SQL Edge Premium EULA can be found here⁠.

MSSQL_SA_PASSWORD is the database system administrator (userid = 'sa') password used to connect to Azure SQL Edge once the container is running. Important note: This password needs to include at least 8 characters of at least three of these four categories: uppercase letters, lowercase letters, numbers and non-alphanumeric symbols.

MSSQL_PID is the Edition that the container will run with. Acceptable values:

• Developer : This will run the container using the Developer Edition (this is the default if no MSSQL_PID environment variable is supplied)
• Premium : This will run the container using the Premium Edition

⁠Related Repos

SQL Server Command Line Tools for Linux: microsoft/mssql-tools⁠

⁠Full Tag Listing

You can retrieve a list of all available tags for azure-sql-edge at https://mcr.microsoft.com/v2/azure-sql-edge/tags/list⁠

Notes:

• GA = General Availability - when the version is officially available and supported.

⁠Known Issues

• Mounting a volume does not work on Docker for Mac

⁠License

• Legal Notice: Container License Information⁠

By passing the value "Y" to the environment variable "ACCEPT_EULA", you are expressing that you have a valid and existing license for the edition and version of SQL Server that you intend to use. You also agree that your use of Azure SQL Edge software running in a Docker container image will be governed by the terms of your Azure SQL Edge license.

To specify the edition, use the MSSQL_PID environment variable. Details can be found in the "Environment Variables" section below.

Azure SQL Edge Developer edition lets developers build any kind of application on top of Azure SQL Edge. It includes all the functionality of Premium edition, but is licensed for use as a development and test system, not as a production server. Azure SQL Edge Developer Edition cannot be used in a production environment. The Azure SQL Edge Developer Edition license terms are located here⁠.