Microsoft SQL Server(DBaaS)

• 1: Overview
• 1.1: Server Types
• 1.2: Monitoring metrics
• 2: How-to guides
• 2.1: DB Service Manage
• 2.2: Backing up and restoring the DB
• 2.3: Secondary Add
• 2.4: Microsoft SQL Server(DBaaS) Server Connection
• 3: API Reference
• 4: CLI Reference
• 5: Release Note

1 - Overview

Service Overview

Microsoft SQL Server (DBaaS) is a representative relational database management system (RDBMS) used in various applications. Samsung Cloud Platform provides an environment that automates Microsoft SQL Server installation and offers management functions for operation through a web-based console.

Microsoft SQL Server (DBaaS) is designed with an Always On-based availability architecture, so when the Primary server’s content changes, it is synchronously replicated to the Secondary server. Additionally, it provides an automatic backup feature at user‑specified times to prepare for issues with the DB server or data, enabling recovery of data at a desired point in time.

Provided features

Microsoft SQL Server (DBaaS) provides the following features.

• Auto Provisioning: UI allows installation and configuration of Database(DB), and provides a Primary-Secondary redundancy configuration based on Always On. When the Primary server fails, it automatically fails over to the Secondary.
• Operation Control Management: Provides functionality to control the state of running servers. In addition to start and stop, restart is possible when there is a DB issue or to apply configuration changes. When configured for high availability (HA), users can manually perform node switching between Primary and Secondary via a switch‑over.
• Backup and Recovery: Provides data backup functionality based on its own backup commands. Users can set the backup time window, retention organization, and Full backup day, and additional fees apply based on backup volume. It also offers a recovery function for backed‑up data, creating a separate DB when the user performs a recovery and restoring to the point in time selected by the user (backup save point, custom point). When restoring to a user‑specified point, the restore time can be set to 5 minutes/10 minutes/30 minutes/1 hour before the stored backup file and archive file.
• Version Management: Provides version upgrade (Minor) functionality for certain feature improvements and security patches. Users can choose whether to perform a backup for the version upgrade, and if a backup is performed, data is backed up before applying the patch, then the DB engine is updated.
• Secondary configuration: You can add a read‑only Read Replica (Secondary Replica), which expands read performance and distributes load.
• Audit Settings: Provides an audit configuration feature that can monitor users’ DB access and the results of DDL (Data Definition Language)/DML (Data Manipulation Language) operations.
• Parameter management: Modification of DB configuration parameters related to performance improvement and security is possible.
• Service Status Query: Retrieves the latest status of the current DB service.
• Monitoring: CPU, memory, DB performance monitoring information can be viewed through the Cloud Monitoring service.
• DB User Management: View and manage DB account (user) information registered in the DB.
• Export DB Log: You can export stored logs to the user’s Object Storage through Audit settings.

Component

Microsoft SQL Server(DBaaS) provides pre-validated engine versions and various server types. Users can select and use them according to the scale of the service they wish to configure.

Engine version

The engine versions supported by Microsoft SQL Server(DBaaS) are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation is halted is set to six months before the EoTS date.

Because the supplier’s policy may cause the EOS and EoTS dates to change, please refer to the supplier’s license management policy page for details.

• Microsoft SQL Server: https://learn.microsoft.com/ko-kr/lifecycle/products/?terms=sql%20server

Server type

The server types supported by Microsoft SQL Server (DBaaS) are as follows.

For detailed information about the server types offered by Microsoft SQL Server (DBaaS), refer to Microsoft SQL Server(DBaaS) Server Types.

Standard db1v2m4

Preliminary Service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service and prepare in advance.

1.1 - Server Types

Microsoft SQL Server(DBaaS) server type

Microsoft SQL Server(DBaaS) provides server types composed of various combinations of CPU, memory, and network bandwidth. When creating a Microsoft SQL Server (DBaaS), the Database Engine is installed according to the server type selected for the intended use.

The server types supported by Microsoft SQL Server (DBaaS) are as follows.

Standard db1v2m4

db1 server type

The db1 server type of Microsoft SQL Server(DBaaS) is provided with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 3rd‑generation (Ice Lake) Xeon Gold 6342 Processor up to 3.3 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

db2 server type

The db2 server type of Microsoft SQL Server (DBaaS) is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 16 vCPUs and 256 GB of memory
• Maximum networking speed of 12.5 Gbps

dbh2 server type

The dbh2 server type of Microsoft SQL Server (DBaaS) is offered with high-capacity server specifications and is suitable for database workloads that require large-scale data processing.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 128 vCPUs and 1,536 GB of memory
• Networking speed up to 25 Gbps

1.2 - Monitoring metrics

Microsoft SQL Server(DBaaS) Monitoring Metrics

The table below shows the performance monitoring metrics for Microsoft SQL Server (DBaaS) that can be viewed through Cloud Monitoring. For detailed usage of Cloud Monitoring, refer to the Cloud Monitoring guide.

Please refer to the Virtual Server Monitoring Metrics guide for Microsoft SQL Server(DBaaS) server monitoring metrics.

2 - How-to guides

Users can create the service by entering the required information for Microsoft SQL Server (DBaaS) and selecting detailed options through the Samsung Cloud Platform Console.

Create Microsoft SQL Server (DBaaS)

You can create and use the Microsoft SQL Server (DBaaS) service from the Samsung Cloud Platform Console.

To create a Microsoft SQL Server (DBaaS), follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server (DBaaS) menu. 1. Navigate to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) Create button. 2. Go to the Microsoft SQL Server(DBaaS) Create page.
3. On the Microsoft SQL Server(DBaaS) Creation page, enter the information required to create the service and select detailed options.
   • Select the required information in the Image and version selection area.

     Category	required status	Detailed description
     Image version	Required	Provide a list of Microsoft SQL Server (DBaaS) versions

     Table. Microsoft SQL Server (DBaaS) Image and version selection options
   • In the Service Information Input area, enter or select the required information.

     Category	required status	Detailed description
     Server name Prefix	Required	Server name where the DB will be installed must start with a lowercase English letter and be entered using lowercase letters, numbers, and the special character (-) with a length of 3 to 13 characters A postfix such as 001, 002 is appended based on the server name to generate the actual server name
     Cluster name	Required	Cluster name of DB servers Enter in English using 3 to 20 characters A cluster is a unit that groups multiple servers
     Service Type > Server Type	Required	Server type for DB installation Standard: Standard specification commonly used High Capacity: Large-capacity server with 24 vCores or more For detailed information about the server types provided by Microsoft SQL Server (DBaaS), refer to Microsoft SQL Server(DBaaS) 서버 타입
     Service Type > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute configured that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Create Planned Compute Service: Navigate to the Planned Compute service application page For more details, refer to Planned Compute Apply
     Service Type > Block Storage	required	Block Storage settings used by the DB according to purpose Basic OS: Area where the DB engine is installed DATA: Storage area for table data, archive files, etc. Select a storage type and then enter the capacity (see Block Storage 생성하기 for details on each Block Storage type) SSD: High‑performance general volume HDD: General volume SSD_KMS, HDD_KMS: Additional encrypted volumes that use Samsung Cloud Platform KMS (Key Management System) encryption keys The configured storage type is also applied to additional storage Capacity must be entered as a multiple of 8 within the range 16 to 5,120 Additional: Data storage area After selecting Use, enter the storage’s purpose and capacity Click the Add button to add storage, or click the x button to delete Capacity can be entered as a multiple of 8 within the range 16 to 5,120, and up to 9 can be created
     Redundant configuration	Select	Redundancy configuration status When redundancy configuration is used, the DB instance is set up as an Active DB and a Standby DB
     Network > Common Settings	Required	Network settings where servers generated by the service are installed Select when you want to apply the same settings to all installed servers Select a pre‑created VPC, Subnet, IP, and Public NAT IP can only be generated automatically The Public NAT feature is available only when the VPC is connected to an Internet Gateway. If you check Use, you can select from reserved IPs in the VPC product’s Public IP. For more details, see Public IP 생성하기
     Network > Server-specific Settings	Required	Network settings for servers created by the service Select when you want to apply different settings for each installed server Select a pre‑created VPC, Subnet, IP, and Public NAT Enter the IP for each server The Public NAT feature is available only when the VPC is connected to an Internet Gateway. Use when checked, you can select a reserved IP from the VPC product’s Public IP. For more details, see Public IP 생성하기
     IP access control	Selection	Service Access Policy Configuration Since the access policy is set for the IP entered on the page, you do not need to configure a separate Security Group policy Enter in IP format (example: 192.168.10.1) or CIDR format (example: 192.168.10.0/24, 192.168.10.1/32) and click the Add button To delete an entered IP, click the x button next to the entered IP
     maintenance period	Select	Database maintenance window If you select Use, set the day of week, start time, and duration It is recommended to set a maintenance window for stable management of the DB. Patch operations will be performed at the scheduled time, causing service interruption If set to unused, Samsung SDS is not responsible for issues arising from unapplied patches.

     Table. Microsoft SQL Server(DBaaS) Service Configuration Items
   • Please enter or select the required information in the Enter required database configuration information area.

     Category	required status	Detailed description
     Database service name	Required	Database management unit name Starts with an uppercase English letter and uses English characters, input 1 ~ 15
     Database name > default	Required	Server name applied during DB installation must start with an English letter and consist of English letters, numbers, and special characters (.,_) with a length of 3 to 20 characters
     Database name > Add	Required	Server name applied during DB installation After selecting use, enter the Database name to install. It must start with an English letter, and using English letters, numbers, and special characters (., _), enter 3 - 20 characters For each Database, the drive where data is stored can be selected from the drives added in Service Type > Block Storage Adding Databases is only possible in the Enterprise edition, and up to 100 can be added
     Database username	Required	DB user name An account with the same name is also created on the OS Enter using lowercase English letters, 2 to 20 characters The following names cannot be used as Database user names root, user, sdscmpif, hacluster, adm, games, nobody, sshd, system, mail, postfix, sa, maxigent_cl
     Database password	Required	Database connection password English letters, numbers, and special characters (“ ‘ excluding) including, enter 8-30 characters
     Database password verification	Required	Check DB connection password Re-enter the DB connection password identically
     Database Port number	Required	DB connection port number Enter DB port within the range 1200 - 65535
     License	Required	SQL Server License Key Enter the issued license key If the entered license key is not valid, the service may not be created
     Backup > Use	Select	Backup usage Select Use to set the backup file retention period, backup start time, Full backup schedule (day of week), and Archive backup interval
     Backup > Retention Period	Selection	Backup retention period Select the backup retention period. Set the file retention period to 7 days ~ 35 days Backup files incur additional charges based on size
     Backup > Backup Start Period	Selection	Backup start time Select backup start time The minutes during which the backup runs (minutes) are set randomly, and the backup end time cannot be set
     Backup > Full backup schedule (day of week)	Select	Full backup schedule Select the day of the week for full backup execution Full backup is performed on a weekly basis
     Backup > Archive backup cycle	Selection	Archive backup frequency Select the archive backup frequency The archive backup frequency is recommended at 1 hour. Selecting 5 minutes, 10 minutes, or 30 minutes may affect DB performance
     Audit Log Settings	Selection	Audit Log storage option Use to enable the Audit Log feature DDL and user connection information records are stored Enabling Audit may degrade DB performance
     Parameter	Required	DB configuration parameters Click the View button to view detailed parameter information Parameters can be modified after the service creation is completed, and a DB restart is required after modification
     DB Collation	Selection	Data sorting method A command that specifies the data sorting and comparison method, which can produce different results depending on the settings.
     time zone	Required	Standard time zone for the database

     Table. Microsoft SQL Server (DBaaS) Database configuration items
   • Additional Information Input area, please enter or select the required information.

     Category	required status	Detailed description
     tag	Select	Add Tag Up to 50 per resource can be added After clicking the Add Tag button, enter or select Key, Value values

     Table. Microsoft SQL Server (DBaaS) additional information input fields
4. Summary Check the detailed information and estimated charges generated in the panel, and click the Create button.
   • Once creation is complete, check the created resource on the Resource List page.

View detailed information of Microsoft SQL Server (DBaaS)

The Microsoft SQL Server (DBaaS) service allows you to view and edit the full resource list and detailed information. Microsoft SQL Server (DBaaS) Details page consists of Details, Tags, Activity History tabs, and when the DB has a Replica configured, a Replica Information tab is added.

To view detailed information about the Microsoft SQL Server (DBaaS) service, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server (DBaaS) menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. From the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Go to the page.
3. Microsoft SQL Server(DBaaS) List Click the resource to view detailed information on the page. 3. Microsoft SQL Server(DBaaS) Details Navigate to the page.
   • Microsoft SQL Server(DBaaS) Details At the top of the page, status information and additional feature information are displayed.

     Category	Detailed description
     Cluster status	Cluster status with DB installed Creating: Cluster is being created Editing: Cluster is transitioning to an operational state Error: Cluster encountered a failure while performing a task If this persists, contact the administrator Failed: Cluster failed during creation Restarting: Cluster is being restarted Running: Cluster is operating normally Starting: Cluster is starting Stopped: Cluster is stopped Stopping: Cluster is being stopped Synchronizing: Cluster is synchronizing Terminating: Cluster is being terminated Unknown: Cluster status is unknown If this persists, contact the administrator Upgrading: Cluster is being upgraded
     Cluster control	Buttons that can change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster Restart: Restart a running cluster Switch-Over: Switch a standby cluster to Active
     More features	Cluster management buttons Service Status Synchronization: Query real-time DB service status Backup History: Verify successful backup execution and view backup history when backup is configured Database Recovery: Recover the DB based on a specific point in time Parameter Management: View and modify DB configuration parameters Add Secondary: Configure a read‑only replica cluster DB User Management: View and manage DB accounts (users) registered in the DB Export DB Log: Export logs stored through audit settings to the user’s Object Storage
     Service cancellation	Service cancellation button

     Table. Microsoft SQL Server(DBaaS) status information and additional features

Detailed information

You can view the detailed information of the selected resource on the Microsoft SQL Server (DBaaS) List page and, if necessary, edit the information.

tag

Microsoft SQL Server (DBaaS) List You can view the tag information of the selected resource on the page, and you can add, modify, or delete it.

Work History

Microsoft SQL Server(DBaaS) List page allows you to view the operation history of the selected resource.

Managing Microsoft SQL Server (DBaaS) Resources

If you need to change the existing configuration options of a provisioned Microsoft SQL Server (DBaaS) resource, or perform recovery, parameter management, etc., you can perform the tasks on the Microsoft SQL Server(DBaaS) Details page.

Control operation

If changes occur to a running Microsoft SQL Server (DBaaS) resource, you can start, stop, or restart it. Also, when HA is configured, you can switch the Primary-Secondary servers via a switch-over.

To control the operation of Microsoft SQL Server (DBaaS), follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server (DBaaS) menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Navigate to the Microsoft SQL Server(DBaaS) List page.
3. Microsoft SQL Server(DBaaS) List On the page, click the resource to control its operation. 3. Microsoft SQL Server(DBaaS) Details Go to the page.
4. Check the Microsoft SQL Server(DBaaS) status and complete the change using the control button below.
   • Start: the server where the DB service is installed and the DB service is running (Running).
   • Stop: The server hosting the DB service and the DB service itself are stopped.
   • Restart: Only the DB service will be restarted.
   • Switch Over: You can switch the Primary and Secondary servers of the DB.

Synchronize service status

You can synchronize the real-time service status of Microsoft SQL Server (DBaaS).

To check the service status of Microsoft SQL Server (DBaaS), follow the steps below.

1. All Services > Database > Microsoft SQL Server(DBaaS) menu, please click. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Navigate to the page.
3. Microsoft SQL Server(DBaaS) List Click the resource on the page to view the service status. 3. Microsoft SQL Server(DBaaS) Details Go to the page.
4. Click the Service Status Synchronization button. 4. During the query, the cluster changes to Synchronizing state.
5. When the query completes, the status in the server information field is updated, and the cluster changes to the Running state.

Change server type

You can change the configured server type.

To change the server type, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Navigate to the Microsoft SQL Server(DBaaS) List page.
3. Microsoft SQL Server(DBaaS) List Click the resource on the page for which you want to change the server type. 3. Microsoft SQL Server(DBaaS) Details Navigate to the page.
4. Click the Edit icon of the server type you want to change at the bottom of the detailed information. 4. Edit Server Type The popup window opens.
5. Edit Server Type After selecting the server type in the popup window, click the Confirm button.

Add storage

If you need more than 5 TB of data storage, you can add additional storage. For a redundant DB configuration, all redundant servers are added simultaneously.

To add storage capacity, follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Navigate to the Microsoft SQL Server(DBaaS) List page.
3. Microsoft SQL Server(DBaaS) List page, click the resource to add storage. 3. Microsoft SQL Server(DBaaS) Details Navigate to the page.
4. Click the Add Disk button at the bottom of the details. 4. Additional Storage Request The popup window opens.
5. Additional Storage Request In the popup window, after entering the purpose and size, click the Confirm button.

Expand storage

Storage added to the data area can be expanded up to a maximum of 5 TB based on the initially allocated capacity. In a redundant DB configuration, all redundant servers are expanded simultaneously.

To increase storage capacity, follow the steps below.

1. All Services > Database > Microsoft SQL Server(DBaaS) Click the menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Go to the page.
3. Microsoft SQL Server(DBaaS) List On the page, click the resource to change the server type. 3. Microsoft SQL Server(DBaaS) Details Navigate to the page.
4. Click the Edit icon of the additional Disk you want to add at the bottom of the detailed information. 4. Edit Additional Storage The popup window opens.
5. Edit Additional Storage In the popup window, after entering the expansion capacity, click the Confirm button.

Cancel Microsoft SQL Server (DBaaS)

You can reduce operating costs by terminating the unused Microsoft SQL Server (DBaaS). However, if you terminate the service, the running service may be stopped immediately, so you should thoroughly consider the impact of service interruption before proceeding with the termination.

To cancel Microsoft SQL Server(DBaaS), follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server (DBaaS) menu. 1. Navigate to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Go to the page.
3. Microsoft SQL Server(DBaaS) List on the page, select the resource to cancel, and click the Cancel Service button.
4. After termination is complete, check on the Microsoft SQL Server(DBaaS) list page whether the resource has been terminated.

2.1 - DB Service Manage

Users can manage Microsoft SQL Server (DBaaS) through the Samsung Cloud Platform Console.

Managing the Database

For the Microsoft SQL Server Enterprise edition, you can add a new database. Up to 100 can be added per cluster.

Add Database

To add a Database, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server (DBaaS) menu. Navigate to the Service Home page of Microsoft SQL Server (DBaaS).
2. Click the Microsoft SQL Server(DBaaS) menu on the Service Home page. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource to add storage. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the Add button in the Database name field. The Add Database popup window opens.
5. In the Add Database popup window, click the + button to enter the Database name and select a drive, then click the Confirm button.

Delete Database

To delete the database, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. Navigate to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. Navigate to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource to add storage. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the Edit button for the Database name field. The Add Database Delete popup window opens.
5. Additional Database Deletion In the request popup, check the Database you want to delete and click the Delete button. The Database Deletion popup opens.
6. Delete Database In the popup window, enter the name of the Database you want to delete, then click the Confirm button.

Managing Parameters

Provides a feature that enables easy viewing and modification of database configuration parameters.

Query Parameter

To view configuration parameters, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. You will be taken to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. Navigate to the Microsoft SQL Server(DBaaS) List page.
3. Microsoft SQL Server(DBaaS) List page, click the resource whose parameters you want to view or modify. Microsoft SQL Server(DBaaS) Details page will open.
4. Click the More button, then click the Parameter Management button. The Parameter Management popup window opens.
5. Parameter Management popup window, click the Search button. Search Notification popup window opens.
6. Lookup Notification When the popup window opens, click the Confirm button. The lookup may take a short amount of time.

Modify Parameter

To modify the configuration parameters, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. Go to the Service Home page of Microsoft SQL Server(DBaaS).
2. Click the Microsoft SQL Server(DBaaS) menu on the Service Home page. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource whose parameters you want to view or modify. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the More button, then click the Parameter Management button. The Parameter Management popup opens.
5. Parameter Management popup window, click the Search button. Search Notification popup window opens.
6. Lookup Notification When the popup window opens, click the Confirm button. Retrieving the data may take a short time.
7. If modification is needed, click the Edit button and enter the changes in the custom value area of the Parameter to be edited.
8. When the input is complete, click the Complete button.

Managing DB Users

Provides functionality to query and manage DB user information.

Query DB Users

To retrieve DB users, follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. Navigate to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource for which you want to view DB users. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the More button, then click the DB User Management button. You will be taken to the DB User Management page.
5. DB User Management page, click the Search button. The search may take a short amount of time.

Change DB User Status

Follow these steps to change the status of the retrieved DB user.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. You will be taken to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource whose DB user you want to modify. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the More button, then click the DB User Management button. You will be taken to the DB User Management page.
5. On the DB User Management page, click the Search button. Retrieving may take a short time.
6. If a correction is needed, click the Edit button, then change the status field value or enter remarks.
7. When the input is complete, click the Complete button.

Modify Audit Settings

You can modify the Audit log storage settings for Microsoft SQL Server (DBaaS).

To change the Audit log storage settings of Microsoft SQL Server(DBaaS), follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. Go to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource to view the service status. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the Edit icon of Audit Settings at the bottom of the detailed information. The Edit Audit Settings popup window opens.
5. Edit Audit Settings After changing the usage in the popup window, click the Confirm button.
   • Use selected, the Audit log feature is enabled. Enabling the Audit log may degrade DB performance.
   • Disabling use will delete the Audit log storage file. Back up the Audit log file separately before disabling.

DB Log Export

Supports exporting log data that requires long-term retention among audit logs to Object Storage. Users can directly set the log types to be stored, the target Bucket for export, and the export interval. Based on the configured criteria, logs are copied to the specified Object Storage for retention. Additionally, to efficiently manage disk space, we also provide an option that exports logs to Object Storage while automatically deleting the original log files. By using this option, you can effectively free up storage capacity while safely retaining the necessary log data for long-term storage.

Setting DB Log Export Mode

To set the DB Log export mode, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. You will be taken to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource whose DB Log you want to export. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the More button, then click the DB Log Export button. You will be taken to the DB Log Export page.
5. On the DB Log Export page, click the Register button. You will be taken to the DB Log Export Register page.
6. On the DB Log Export Registration page, after entering the required information, click the Complete button.

   Category	Required	Detailed description
   Log type	Required	Log type to be saved
   Save bucket name	Required	Object Storage bucket name to be saved
   Authentication key > Access key	Required	Access key to access the Object Storage you want to store
   Authentication key > Secret key	Required	Secret key for accessing the Object Storage you want to store
   File creation interval	Required	File creation frequency in Object Storage
   Whether to delete the original log	Selection	Whether to delete the original logs when exporting to Object Storage

   Table. Microsoft SQL Server (DBaaS) DB Log Export Configuration Items

Managing DB Log Export

To modify, cancel, or immediately export the DB Log export settings, follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. Navigate to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource you want to manage DB Log export for. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the More button, then click the DB Log Export button. You will be taken to the DB Log Export page.
5. On the DB Log Export page, depending on the log type you want to manage, click the More button and then click the Export Now, Edit, or Cancel buttons.
   • Export Immediately: The selected logs are exported to the bucket of the previously configured Object Storage.
   • Edit: Modify the DB Log export mode settings.
   • Cancel: Cancel the DB Log export mode setting.

Minor Version Upgrade

We provide version upgrade functionality for some feature improvements and security patches. Only Minor version upgrades within the same Major version are supported.

To upgrade the Minor Version, follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. Navigate to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. Microsoft SQL Server(DBaaS) List page, click the resource to upgrade the version. Navigate to the Microsoft SQL Server(DBaaS) Details page.
4. Click the Edit button of the Image version item. The Version Upgrade popup window opens.
5. Version Upgrade In the popup, select the updated version and backup setting, then click the Confirm button.
6. Version Upgrade Notification Click the Confirm button in the popup window.

2.2 - Backing up and restoring the DB

Users can configure backups of Microsoft SQL Server (DBaaS) through the Samsung Cloud Platform Console and restore from the backed‑up files.

Microsoft SQL Server(DBaaS) Backup

Microsoft SQL Server (DBaaS) provides a data backup feature based on its own backup commands. Additionally, it provides an optimized backup environment for data protection and management through backup history verification and backup file deletion features.

Configure backup

For backup configuration of Microsoft SQL Server (DBaaS), see the Microsoft SQL Server(DBaaS) Creating guide.

To modify the backup settings of the created resource, follow the steps below.

1. All Services > Database > Microsoft SQL Server(DBaaS) Click the menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Navigate to the page.
3. Microsoft SQL Server(DBaaS) List Click the resource on the page to configure backup. 3. Microsoft SQL Server(DBaaS) Details Navigate to the page.
4. Click the Edit button for the backup item. 4. Backup Settings popup opens.
5. When setting up a backup, click Use in the Backup Settings popup, select retention period, backup start time, and Archive backup interval, then click the Confirm button.
   • If you stop the backup configuration, deselect Use in the Backup Settings popup and authenticate using the logged-in user’s mobile phone.
     Once user authentication is complete, the backup configuration is disabled and backup execution stops.

Check backup history

To view the backup history, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Go to the page.
3. Microsoft SQL Server(DBaaS) List page, click the resource to view the backup history. 3. Microsoft SQL Server(DBaaS) Details Navigate to the page.
4. Click the Backup History button. 4. Backup History The popup window opens.
5. Backup History In the popup window, you can view the backup status, version, backup start time, backup completion time, and size.

Delete backup file

To delete the backup history, follow these steps.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. 1. Go to the Service Home page of Microsoft SQL Server (DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Navigate to the page.
3. Microsoft SQL Server(DBaaS) List Click the resource on the page to view the backup history. 3. Microsoft SQL Server(DBaaS) Details Go to the page.
4. Click the Backup History button. 4. Backup History The popup window opens.
5. Backup History In the popup, check the files you want to delete, then authenticate via the logged-in user’s mobile phone.
   • When user authentication is completed, the backup file is deleted.

Microsoft SQL Server(DBaaS) Recovery

If a backup file needs to be restored due to a failure or data loss, the recovery feature allows restoration based on a specific point in time. When you perform a Microsoft SQL Server(DBaaS) recovery, a new server is created with the OS image from the initial provisioning point, the database is installed with the version from the backup point, and the recovery proceeds using the database’s configuration information and data.

To recover Microsoft SQL Server (DBaaS), follow the steps below.

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. 1. Go to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. 2. Microsoft SQL Server(DBaaS) List Navigate to the page.
3. Microsoft SQL Server (DBaaS) resource On the list page, click the resource you want to recover. 3. Microsoft SQL Server(DBaaS) Details Go to the page.
4. Click the Database Recovery button. 4. Go to the Database Recovery page.
5. After entering the relevant information in the Database Recovery Configuration area, click the Complete button.

   Category	required status	Detailed description
   Recovery Type	required	Set the point in time the user wants to recover Backup point (recommended): Recover based on the backup file. Select from the list of backup points displayed in the list Custom point: Recover to a user‑desired point within the range of recoverable backup times. The recoverable period depends on the Archive backup cycle setting, allowing recovery from the initial backup start time up to 1 hour/30 minutes/10 minutes/5 minutes before the current time. Select the date and time to back up
   Server name prefix	Required	Recovery DB server name Start with a lowercase English letter and use lowercase letters, numbers, and special characters (-) to enter 3 to 16 characters Based on the server name, a postfix such as 001, 002 is appended to generate the actual server name
   Cluster name	Essential	Recovery DB cluster name Enter using English letters, 3 ~ 20 characters A cluster is a unit that groups multiple servers
   Service Type > Server Type	Required	Recovery DB Server Type Standard: Standard specification commonly used High Capacity: Large-capacity server with 24 vCores or more
   Service Type > Planned Compute	Selection	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute configured that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Create Planned Compute Service: Navigate to the Planned Compute service application page For more details, see Planned Compute Apply
   Service Type > Block Storage	Required	Block Storage settings used by the recovery DB Base OS: Area where the DB engine is installed DATA: Data storage area Applied identically with the storage type set in the source cluster Enter capacity as a multiple of 8 within the range 16 to 5,120 Additional: Data storage area Applied identically with the storage type set in the source cluster In the recovery DB, only DATA and TEMP purposes can be added After selecting Use, enter the storage purpose and capacity To add storage, click the Add button, and to delete, click the x button Capacity can be entered as a multiple of 8 within the range 16 to 5,120, and up to 9 can be created
   Database username	Required	Database username Apply the same username set in the original cluster
   Database Port number	Essential	Database Port number Apply the same Port number as set in the original cluster
   IP access control	Select	Service Access Policy Configuration Since the access policy is set for the IP entered on the page, you do not need to configure a separate Security Group policy Enter in IP format (example: 192.168.10.1) or CIDR format (example: 192.168.10.0/24, 192.168.10.1/32) and click the Add button To delete an entered IP, click the x button next to the entered IP
   maintenance period	Select	Database maintenance window If you select Use, set the day, start time, and duration It is recommended to set a maintenance window for stable management of the DB. Patch operations will be performed at the scheduled time, causing service interruption If set to not use, Samsung SDS is not responsible for issues arising from unapplied patches.
   tag	Selection	Add Tag After clicking the Add Tag button, enter or select Key, Value

   Table. Microsoft SQL Server (DBaaS) recovery configuration items

2.3 - Secondary Add

The user can enter the required information for Secondary through the Samsung Cloud Platform Console and create the service using detailed options.

Add Secondary

You can create a read‑only replica server by configuring a Secondary. To add additional Secondaries, they must be created with a high‑availability (HA) configuration and Enterprise Edition, and the backup feature must be enabled.

To configure Secondary, follow the steps below.

1. All Services > Database > Microsoft SQL Server(DBaaS) Click the menu. Navigate to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Microsoft SQL Server(DBaaS) menu. You will be taken to the Microsoft SQL Server(DBaaS) List page.
3. On the Microsoft SQL Server(DBaaS) List page, click the resource to configure Secondary. You will be taken to the Microsoft SQL Server(DBaaS) Details page.
4. Click the Secondary Add button. Navigate to the Secondary Add page.
5. After entering information in the Secondary configuration area, click the Create button.

   Category	Required status	Detailed description
   Secondary number	Required	Number of Secondary to configure Only one can be configured per cluster
   Secondary name	Required	Secondary server name must start with a lowercase English letter, and use lowercase letters, numbers, and special characters(-) to enter 3 to 15 characters The entered Secondary name is displayed as the cluster name in the list
   Service Type > Server Type	Required	Secondary server type Apply the same as the server type set in the source DB
   Service Type > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Create Planned Compute Service: Go to the Planned Compute service request page For more details, refer to Apply for Planned Compute
   Network > Common Settings	Required	Network settings where servers generated by the service are installed Applied identically to the network settings configured in the original DB
   Network > Server-specific Settings	Required	Network settings for servers deployed by the service Select when you want to apply different settings per installed server Apply the same network settings as configured in the source DB When configuring per server 10.10.10.0/24 Enter an IP address within the range
   License	Required	SQL Server License Key Enter the issued license key If the entered license key is not valid, the service may not be created

   Table. Microsoft SQL Server (DBaaS) Secondary configuration items

2.4 - Microsoft SQL Server(DBaaS) Server Connection

Scenario Overview

Microsoft SQL Server(DBaaS) server connection scenario involves creating a Bastion host (Virtual Server) and a Database service, and accessing the DB service through the Bastion host. To reliably connect to Microsoft SQL Server(DBaaS) in the Samsung Cloud Platform environment, you need to create a Bastion host and establish network connectivity through it. To maintain stability and a high level of security, it is recommended to configure the Database service in a Private Subnet environment and place the Bastion host in a restricted Public Subnet environment.

This scenario primarily describes creating a Bastion host and a Database service, configuring the network environment for Bastion host and Database access, and connecting through a DB client.

Scenario components

You can build the scenario using the following services.

Scenario setup method

Create the services required to compose the scenario by following the steps below.

Set up the network

Describes the process of configuring the network environment for accessing the Bastion Host and Database services.

1-1. Create VPC

1. Click the All Services > Networking > VPC menu. You will be taken to the VPC Service Home page.
2. Click the VPC Creation button on the Service Home page. You will be taken to the VPC Creation page.
3. On the VPC Creation page, enter the information required to create the service.
   • Enter the IP range as 192.168.x.0/16.
4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • When creation is complete, check the created resources on the VPC List page.

1-2. Create Subnet

1. Click the All Services > Networking > VPC menu. You will be taken to the VPC Service Home page.
2. On the Service Home page, click the Subnet menu. You will be taken to the Subnet List page.
3. Click the Create Subnet button. You will be taken to the Create Subnet page.
4. On the Subnet Creation page, enter the information required to create the service.
   • Select the Subnet type as General.
   • Select a pre‑created VPC.
   • Enter the IP range as 192.168.x.0/24.
5. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • After creation is complete, check the created resources on the Subnet list page.

1-3. Create Internet Gateway

1. Click the All Services > Networking > VPC menu. Navigate to the VPC’s Service Home page.
2. On the Service Home page, click the Internet Gateway menu. You will be taken to the Internet Gateway List page.
3. Click the Create Internet Gateway button. Navigate to the Create Internet Gateway page.
4. Internet Gateway Creation page, enter the required information for creating the service.
   • Select a pre‑created VPC.
   • In the Firewall usage option, select Use.
5. In the Summary panel, verify the detailed information and estimated billing amount, and click the Complete button.
   • Once creation is complete, verify the created resource on the Internet Gateway List page.

1-4. Create Public IP

1. Click the All Services > Networking > VPC menu. Navigate to the VPC Service Home page.
2. Click the Public IP menu on the Service Home page. You will be taken to the Public IP List page.
3. Click the Public IP Reservation button. You will be taken to the Public IP Reservation page.
4. On the Public IP reservation page, enter the required information needed to reserve the service.
5. In the Summary panel, verify the detailed information and estimated billing amount, then click the Complete button.
   • When creation is complete, check the created resources on the Public IP list page.

1-5. Create Security Group

1. Click the All Services > Networking > Security Group menu. Navigate to the Service Home page of Security Group.
2. Click the Create Security Group button on the Service Home page. You will be taken to the Create Security Group page.
3. On the Security Group creation page, enter the required information needed to create the service.
4. Check the input information and click the Complete button.
   • When creation is complete, check the created resources on the Security Group list page.

Create Bastion host

Describes the process of configuring a Bastion Host that requires the database client to be installed.

2-1. Create Server Keypair

1. Click the All Services > Compute > Virtual Server menu. Navigate to the Service Home page of Virtual Server.
2. On the Service Home page, click the Keypair menu. You will be taken to the Keypair List page.
3. Click the Create Keypair button. You will be taken to the Create Keypair page.
4. Enter the required information for creating a service on the Keypair creation page.
5. Verify the creation information and click the Complete button.
   • The key can be downloaded only on the first attempt, and reissuance is not available.
   • Please store the downloaded key in a secure location.

2-2. Create Bastion host

1. Click the All Services > Compute > Virtual Server menu. Navigate to the Service Home page of Virtual Server.
2. On the Service Home page, click the Create Virtual Server button. You will be taken to the Create Virtual Server page.
3. On the Virtual Server Creation page, enter the required information to create the service.
   • Select Windows for the image.
   • Select the pre-created VPC and Subnet.
   • Click Use NAT, then select the reserved Public IP from 1-4. Create Public IP.
   • Connect the Keypair created in 2-1. 서버 Keypair 생성하기.
4. In the Summary panel, verify the detailed information and estimated billing amount, then click the Complete button.
   • When creation is complete, check the created resources on the Virtual Server List page.

2-3. Verify Bastion host login ID and PW

1. Click the All Services > Compute > Virtual Server menu. Navigate to the Service Home page of Virtual Server.
2. On the Service Home page, click the Virtual Server menu. You will be taken to the Virtual Server List page.
3. On the Virtual Serve List page, click the resource you created in 2-2. Bastion host Create. You will be taken to the detailed information page for that resource.
4. On the detail information page, click the RDP password view button in the Keypair name field. The RDP password view popup window opens.
5. In the popup window, perform RDP password lookup, and attach the keypair file downloaded from 2-1. Create Server Keypair.
6. After attaching, click the Password Check button. The ID and Password for accessing the resource are displayed.
   • The ID and password will later be used as credentials to connect to the Bastion host in 5-1. Bastion host Connecting.

Create Database

Describes the process of creating a Database service.

3-1. Microsoft SQL Server(DBaaS) Create Service

1. Click the All Services > Database > Microsoft SQL Server(DBaaS) menu. Go to the Service Home page of Microsoft SQL Server(DBaaS).
2. On the Service Home page, click the Create Microsoft SQL Server (DBaaS) button. Navigate to the Create Microsoft SQL Server (DBaaS) page.
3. On the Microsoft SQL Server(DBaaS) Creation page, enter the required information to create the service.
   • Select the pre‑created VPC and Subnet and connect them.
   • Enter database-related creation details on the required information input screen.
   • Add the Bastion host IP in the IP access control settings.
   • The database port defaults to 2866, but users can also specify it.
4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • After creation is complete, check the created resource on the Microsoft SQL Server(DBaaS) list page.

Configuring Rules

It explains the process of configuring rules for a user to connect to the Bastion host and rules for connecting to the Database from the Bastion host.

4-1. Adding security rules to Security Group

1. Click the All Services > Networking > Security Group menu. Go to the Service Home page of Security Group.
2. Click the Security Group menu on the Service Home page. You will be taken to the Security Group List page.
3. 1-5. Creating a Security Group Select the Security Group resource you created. Navigate to the detailed information page for that resource.
4. Click the Rules tab on the detail page. You will be taken to the Rules tab.
5. On the Rules tab, click the Add Rule button. It takes you to the Add Rule popup.
6. Add Rule In the popup window, enter the rule below, and click the Confirm button.

   direction	remote	target address	Protocol	Port	Explanation
   Inbound	CIDR	User PC IP	TCP	3389 (RDP)	Bastion client PC → Bastion host
   Outbound	CIDR	DB IP	TCP	Database Port (manual entry)	Bastion host → Database

   Table. Security Group rules that need to be added

4-2. Add IGW Firewall rule

1. All Services > Networking > Firewall Click the menu. Then navigate to the Service Home page of Firewall.
2. From the Service Home page, click the Firewall menu. You will be taken to the Firewall List page.
3. On the Firewall List page, select the Internet Gateway resource name created in 1-3. Create Internet Gateway. You will be taken to the detailed information page of that resource.
4. Click the Rules tab on the detail information page. You will be taken to the Rules tab.
5. Click the Add Rule button on the Rules tab. It navigates to the Add Rule popup.
6. Add Rule In the popup window, enter the rule below, and click the Confirm button.

   origin address	Destination address	Protocol	Port	operation	direction	Explanation
   Bastion connection PC IP	Bastion host IP	TCP	3389(RDP)	Allow	Inbound	User PC → Bastion host

   Table. Internet Gateway Firewall rules that need to be added

Connect to Database

Describes the process of a user accessing the database via a DB client program.

This guide explains how to connect using SSMS(Microsoft SQL Server Management Studio). Since there are various database client programs and CLI utilities, you may install and use the tool that best fits your needs.

5-1. Connect to Bastion host

1. In the Windows environment of the PC that will connect to the Bastion host, run Remote Desktop Connection, then enter the NAT IP of the Bastion Host and click the Connect button.
2. When the remote desktop connection succeeds, the user credential input window opens. Enter the ID and Password verified in 2-3. Check Bastion host login ID and PW and click the Confirm button.

5-2. Install the DB client program (SSMS) on the Bastion host

1. Go to the official Microsoft SQL Server page and download the SSMS program.
   • SSMS program download URL: https://learn.microsoft.com/en-us/ssms/download-sql-server-management-studio-ssms
2. Connect the user’s PC hard drive to upload the file to the Bastion host.
3. In the Remote Desktop Connection’s Local Resources tab, click the Details button for the Local Devices and Resources item.
4. Select the local disk of the location where the file was downloaded on the drive, and click the OK button.
5. Copy the downloaded file, upload it to the Bastion Host, and click the SSMS (Microsoft SQL Server Management Studio) installation file to install.

5-3. Connect to the Database using the DB client program (SSMS)

1. Run SSMS (Microsoft SQL Server Management Studio). A Connect to Server popup will appear.
2. Connect to Server In the popup window, enter the Database server information created in 3-1. Microsoft SQL Server(DBaaS) 서비스 생성하기 and click the Connect button.

   Required input field	input value
   Server type	Database Engine
   Server name	Database server IP, Database Port (ex. 192.168.10.1,2866)
   Authentication	SQL Server Authentication
   Login	Database username
   Password	Database password
   Encryption	Optional

   Table.DB connection client program input fields
3. Once the connection is established, the database will be accessed. After connecting, you can execute simple queries, among other tasks.

3 - API Reference

4 - CLI Reference

5 - Release Note

Microsoft SQL Server(DBaaS)