Radius.Data/sqlServerDatabases@2025-08-01-preview

Description

The Radius.Data/sqlServerDatabases Resource Type deploys a SQL database. Provide the administrator username and password directly on the resource. The password property is marked x-radius-sensitive, so Radius encrypts it at rest, redacts it on reads, and exposes it (decrypted) only to the recipe that provisions the database.

resource sqlserver 'Radius.Data/sqlServerDatabases@2025-08-01-preview' = {
  name: 'sqlserver'
  properties: {
    environment: environment
    application: myApplication.id
    database: 'appdb'
    username: 'myadmin'
    // From a @secure() password parameter passed in via the CLI
    password: password
  }
}

When deploying the application definition, provide the database password value as a parameter. It is recommended to use a password generator such as openssl or equivalent. For example, rad deploy app.bicep -p password=$(openssl rand -hex 16).

To connect your container to the database, create a connection from the Container resource to the database as shown below. This verification test is provisioning-only because the stock demo image has no SQL Server backend, but the type still exposes a connection surface for applications that can use it.

resource frontend 'Radius.Compute/containers@2025-08-01-preview' = {
  name: 'frontend'
  properties: {
    application: myApplication.id
    environment: environment
    container: {
      image: 'frontend:1.25'
    }
    connections: {
      sqlserver: {
        source: sqlserver.id
      }
    }
  }
}

The connection automatically injects environment variables into the container for all properties from the database. The environment variables are named CONNECTION_<CONNECTION-NAME>_<PROPERTY-NAME>. In this example the connection name is sqlserver so the environment variables will be:

  • CONNECTION_SQLSERVER_DATABASE
  • CONNECTION_SQLSERVER_HOST
  • CONNECTION_SQLSERVER_PORT

The schema is platform-neutral: the same developer-facing properties can be backed by Azure SQL Database, AWS RDS for SQL Server, or a Kubernetes SQL Server recipe by changing only the platform recipe’s module source, parameters, and outputs. Azure maps host from the AVM fullyQualifiedDomainName output; AWS Terraform would map an RDS endpoint; Kubernetes would map a Service DNS name.

Top-Level Properties

PropertyTypeDescription
applicationstring(Optional) The Radius Application ID. myApplication.id for example.
codeReferencestringOptional URI to the source code of this resource type. ex: https://github.com/radius-project/radius/blob/4fab87e8127adf1db6f43b7029d5235fbe82c5c9/cmd/controller/main.go#L27
connectionsobjectMap of connection name to connection data.
databasestring(Required) The SQL database name to create on the server. Defaults to appdb in the sample application.
environmentstring(Required) The Radius Environment ID. Typically set by the rad CLI. Typically value should be environment.
hoststring(Read Only) The SQL Server fully qualified domain name. Mapped from the recipe module’s fullyQualifiedDomainName output.
passwordstring(Required) The administrator password for the SQL database. Marked x-radius-sensitive: Radius encrypts it at rest, redacts it on reads, and exposes it decrypted only to the recipe as {{context.resource.properties.password}}.
portinteger(Optional) The TCP port used to connect to the database. Defaults to 1433, the standard SQL Server port that every Recipe in this repository provisions and the port Azure SQL Database is fixed to. A Recipe that provisions the database on a different port reports the real port as an output, which overwrites this value once the deployment finishes. Setting it in an application definition changes only the value reported to connected containers, never the port the server listens on, so leave it unset.
usernamestring(Required) The administrator username for the SQL database. Provided directly on the resource and passed to the recipe as {{context.resource.properties.username}}.

Object Properties

connections

PropertyTypeDescription
disableDefaultEnvVarsbooleanDisables the automatic injection of environment variables from the connected resource’s properties.
sourcestringResource ID of the source resource for this connection.