YAML for Microsoft SQL Server

View as Markdown

Microsoft SQL Server target for executing queries on an MSSQL database.

YAML parameters for Microsoft SQL Server

PARAMETERS

hostrequiredstring

The hostname or IP address of the MSSQL server

targetrequiredstring

The human-readable ID of the target

namestring

The name of the target

portstring

The port of the MSSQL server. Default: 1433

databasestring

The default database name

ssl_modestring enum

SSL connection mode. Default: REQUIRE, which encrypts but does NOT validate the server certificate (vulnerable to MITM); full certificate validation requires ca_certificate.

Allowed enum:

DISABLE,

REQUIRE,

VERIFY_FULL

ca_certificatestring

PEM-encoded CA certificate (required when ssl_mode is VERIFY_FULL)

authMssqlAuthYaml

MSSQL authentication credentials

proxystring

SSH proxy target for tunneling to private MSSQL servers

permissionsPermissionsYaml

Access permissions for the target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with the target

use_asUseAsYaml

Defines how the target can be used (as deployment target, proxy, or both)

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

typestring

Value: MSSQL

Last modified on Sep 17, 2026

Kubernetes Cluster MongoDB

YAML examples for Microsoft SQL Server

Microsoft SQL Server target with full certificate validation

yaml
- target: production_mssql
  type: MSSQL
  name: Production MSSQL
  host: mssql.example.com
  port: "1433"
  database: app
  ssl_mode: VERIFY_FULL
  ca_certificate: |-
    -----BEGIN CERTIFICATE-----
    MIIDdzCCAl+gAwIBAgIEexampleCAcertificateENCODEDinPEMformat
    -----END CERTIFICATE-----
  auth:
    username: app_user
    password: $password
  proxy: my_ssh_bastion
  tags:
    - mssql
    - production

Minimal

yaml
- target: production_mssql
  type: MSSQL
  host: mssql.example.com
  auth:
    username: app_user
    password: $password