Assets

This page documents the following assets:

• Database — Represents a database provisioned through the DBaaS platform.
• Database User — Represents a SQL user provisioned through the DBaaS MSSQL platform.

Database

Represents a database provisioned through the DBaaS platform.

Schema

The following properties describe a Database:

Property	Type	Description
availability_mode Computed	string	Availability mode/role for the replica hosting database
cluster_name Computed	string	Cluster name
connections Computed	number	Connections Nb per database.
db_roles	list(string)	Optional database roles to grant to user
db_user	string	Optional database user to create & map to new database
db_user_id Computed	string	The console asset ID of the database_user created alongside this database.
endpoint Computed	string	Endpoint hosting database
instance Default	string	SQL Server instance name
name RequiredForceNew	string	The name of the database.
password_location Computed	string	The Vault UI URL where the default user password is stored.
product_version Computed	string	SQL Server product version for the hosting instance
server Computed	string	SQL Server hostname
size_gb Computed	number	Database Size in GB.

Examples

---

Database User

Represents a SQL user provisioned through the DBaaS MSSQL platform.

Schema

The following properties describe a Database User:

Property	Type	Description
create_date Computed	string	SQL Server login creation date
database_roles Computed	string	Per-database role memberships as JSON (db_name to roles mapping)
databases Required	list(string)	Databases on which this user has permissions
db_roles Required	list(string)	Database roles granted to the user
db_user RequiredForceNew	string	SQL user name
instance Default	string	Logical SQL instance name
is_disabled Computed	string	Whether the SQL Server login is disabled (true/false)
password_location Computed	string	The Vault UI URL where the user password is stored.
server_roles Computed	string	Server-level role memberships (e.g. sysadmin, setupadmin)
sid Computed	string	SQL Server login security identifier (SID)

Examples