SQL Server
Last updated
Last updated
/databases/sqlserver
Names, example: resource01,!resource02,resource42
Environments, example: PRODUCTION,DEVELOPMENT
Status, example: ACTIVE,INACTIVE
Tags, example: mytagkey:mytagvalue,application:itcare
Results page you want to retrieve (0..N)
Number of records per page.
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.
This method allows to create a SQL Server 2022 platform.
You will have to know at the minimum :
name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.volumes attribute). Initially, 5 disks are allocated and you can create one more. The first disk with id disk0 represents the "C: System", its maximum possible value is 70 and minimum is 1 (representing GB). disk1 represents "D: Root Instance", disk2 represents "E: User Databases", disk 3 represents "F: User Log" and disk4 represents "G: TempDB". The maximum possible value for these disks is 4096 and the minimum is 10 (representing GB).customerPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 8.serviceId attribute).networkId attribute).area attribute).collation attribute).edition attribute) whether it's "STD" or "ENT"This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
optional fields:
az attribute) default az of area will be used if not providedauthenticationDomainId attribute)alwaysOn attribute) default is falsessis attribute) default is falsessrs attribute) default is falsessas attribute) default is falseasServerModeStd attribute) which will be considered only if ssas is trueasCollation attribute) which will be considered only if ssas is truefullText attribute) default is falseavailabilityMode attribute)failoverMode attribute)readableSecondary attribute)witness attribute)listenerName attribute)POST /sqlserver
{
"name":"RSQL22",
"nodeSizing":"2cpu8gb",
"volumes":[
{
"id":"disk3",
"sizeGb":10
},
{
"id":"disk4",
"sizeGb":10
},
{
"id":"disk2",
"sizeGb":30
},
{
"id":"disk1",
"sizeGb":30
},
{
"id":"disk0",
"sizeGb":70
}
],
"area":"EB-QA",
"customerPassword":"P@ssw0rd",
"collation":"French_BIN",
"edition":"STD",
"serviceId":2423,
"networkId":5000802
}
/databases/sqlserver
Cluster/Basic Always On, example: true
Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Collation for Analysis Services
Modelisation type
Modelisation type, example: TABULAR
authentication domain id, example: CGDM-EMEA
Cluster availability mode, example: Synchronous_commit
Availability zone of SQL Server
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
Database Collation, example: French_BIN
Customer Password
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
SQL Server edition, example: ENT
Cluster failover mode, example: Read-intent_only
Whether Full-Text search is enabled or not
Cluster listener name, example: rhusqllsnr01
Indicates if alerting should be activated. If absent, set to false.
Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.
Name of SQL Server
The network Id of the ELS cluster
Indicates why a production resource is not under backup.
Indicates why a production resource is not under monitoring.
Indicates why a production resource is not replicated.
cluster nodes number, example: 3
Node sizing for cluster
Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.
Product platform of the cluster
Prefix name of SQL Server
Cluster readable secondary, example: YES, NO, READ_ONLY
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
id of service to put instance in.
specific request to be done by an administrator. Can differ delivery of instance up to 24h., example: Could you please install .NET framework 4.5 on instance ? Thanks.
SQL Server Analysis Services (SSAS)
SQL Server Integration Services (SSIS)
SQL Server Reporting Services (SSRS)
Volume specification
This method allows to delete a SQL Server instance.
This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.
DELETE /compute/databases/sqlserver/1234
DELETE /compute/databases/sqlserver/1234
{
"changeReference": "56789"
}
/databases/sqlserver/{id}
id, example: 123
Optional reference for change
This method allows to update a SQL Server Farm.
Structure of payload is generic and describes :
operation you want to be performedoptions data relative to the operation performed - see details - optional.Below are different operations currently implemented.
Start SQL Server Farm
Use the start operation to start the SQL Server Farm.
This method is synchronous (status code 202).
Example :
PATCH /compute/databases/sqlserver/1234
{
"operation": "start"
}
Stop SQL Server Farm
Use the stop operation to stop the SQL Server Farm.
This operation cannot be undone afterwards.
This method is synchronous (status code 202).
PATCH /compute/databases/sqlserver/1234
{
"operation": "stop"
}
PATCH /compute/databases/sqlserver/1234
{
"operation": "stop",
"options": {
"changeReference": "56789"
}
}
Reset SQLServer Farm
Use the reset operation to reset the SQL Server Farm.
This method is synchronous (status code 202).
Example :
PATCH /compute/databases/sqlserver/1234
{
"operation": "reset"
}
Resize SQLServer instance
Use the resize operation to resize the nodes of the SQLServer instance and the instance itself.
This operation cannot be undone afterwards.
This method is asynchronous (status code 202).
PATCH /compute/databases/sqlserver/1234
{
"operation":"resize",
"options": {
"sizing": "2cpu4gb"
}
}
Update Monitoring
Use the update_monitoring operation to update the monitoring state of the SQL Server.
Use the state option to turn on/off monitoring.
Use the on_call option to turn on/off 24/7 monitoring.
This method is synchronous (status code 202).
PATCH /compute/databases/sqlserver/1234
{
"operation": "update_monitoring",
"options": {
"state": true,
"on_call": true
}
}
Update Patch Party
Use the update_patch_party operation to update the patch party scheduled plan of the SQLServer.
excluded option to turn on/off patch party.patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.exclusionReason option to explain the reason of excluding the resource from patch part.This method is synchronous (status code 202).
PATCH /compute/databases/sqlserver/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": false,
"patchGroup": "3"
}
}
}
PATCH /compute/databases/sqlserver/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": true,
"exclusionReason": "I want to handle this by myself"
}
}
}
/databases/sqlserver/{id}
id, example: 123
Operation to perform on target object, example: operation_name
Specific payload to pass to have the operation performed. Refer to documentation for each operation.