Microsoft SQL Server

Resource type

ms_sql_server — the shape of the credential every script on this page expects.

Field	Type	Required	What it is
host	string	Yes
user	string	No
password	string	No
integrated_auth	boolean	No	Use Windows Integrated Authentication (Kerberos). When enabled, the worker's service account credentials are used instead of username/password. Requires the worker to have a valid Kerberos ticket.
aad_token	object	No	AAD token for authentication
port	number	No
dbname	string	Yes
instance_name	string	No
trust_cert	boolean	No	Trust any certificate presented by the server
ca_cert	string	No	CA certificate in PEM format for verifying the server identity. Only needed if the certificate used by the server is not in the workers's trust store.
encrypt	boolean	No	Enable TLS encryption. When false, all data including passwords are sent unencrypted over the network. Set to false only for local development.