Skip to main content

types

Access​

dataLens : bool​

Allows access for DataLens.

webSql : bool​

Allows access for Web SQL.

Backup​

An SQL Server backup resource.

For more information, see the Backup section in the documentation.

id : string​

ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp​

Time when the backup operation was completed.

sourceClusterId : string​

ID of the SQL Server cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Time when the backup operation was started.

databases : string​

List of databases included in the backup.

Cluster​

An SQL Server cluster.

For more information, see the Concepts section of the documentation.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    State of the cluster is unknown ([Host.health][1] of all hosts in the cluster is UNKNOWN).

  • ALIVE

    Cluster is alive and works well ([Host.health][2] of all hosts in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][3] of all hosts in the cluster is DEAD).

  • DEGRADED

    Cluster is in degraded state ([Host.health][4] of at least one of the hosts in the cluster is not ALIVE).

Status​

  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster encountered a problem and cannot operate.

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster stopped.

  • STARTING

    Cluster is starting.

id : string​

ID of the SQL Server cluster.

This ID is assigned by Managed Service for SQL Server at the moment of creation.

folderId : string​

ID of the folder the SQL Server cluster belongs to.

createdAt : google.protobuf.Timestamp​

Time when SQL Server cluster was created.

name : string​

Name of the SQL Server cluster.

The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.

description : string​

Description of the SQL Server cluster.

Must be 0-256 characters long.

labels : string​

Custom labels for the SQL Server cluster as key:value pairs.

Maximum 64 per resource.

environment : Environment​

Deployment environment of the SQL Server cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the SQL Server cluster.

config : ClusterConfig​

Configuration of the SQL Server cluster.

networkId : string​

ID of the network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

securityGroupIds : string​

User security groups.

deletionProtection : bool​

Determines whether the cluster is protected from being deleted.

sqlcollation : string​

SQL Server Collation.

hostGroupIds : string​

Host groups hosting VMs of the cluster.

serviceAccountId : string​

ID of the service account which is used for access to Object Storage.

ClusterConfig​

SecondaryConnections​

  • SECONDARY_CONNECTIONS_UNSPECIFIED

  • SECONDARY_CONNECTIONS_OFF

    Connections to secondary replicas are prohibited

  • SECONDARY_CONNECTIONS_READ_ONLY

    Secondary replicas are read-only

version : string​

Version of the SQL Server.

One of sqlserverConfig​

Configuration of the SQL Server instances in the cluster.

  • sqlserverConfig_2016sp2std : config.SQLServerConfigSet2016sp2std​

    Configuration of the SQL Server 2016sp2 standard edition instance.

  • sqlserverConfig_2016sp2ent : config.SQLServerConfigSet2016sp2ent​

    Configuration of the SQL Server 2016sp2 enterprise edition instance.

  • sqlserverConfig_2017std : config.SQLServerConfigSet2017std​

    Configuration of the SQL Server 2017 standard edition instance.

  • sqlserverConfig_2017ent : config.SQLServerConfigSet2017ent​

    Configuration of the SQL Server 2017 enterprise edition instance.

  • sqlserverConfig_2019std : config.SQLServerConfigSet2019std​

    Configuration of the SQL Server 2019 standard edition instance.

  • sqlserverConfig_2019ent : config.SQLServerConfigSet2019ent​

    Configuration of the SQL Server 2019 enterprise edition instance.

resources : Resources​

Resources allocated to SQL Server hosts.

backupWindowStart : google.type.TimeOfDay​

Start time for the daily backup in UTC timezone.

access : Access​

Database access policy.

secondaryConnections : SecondaryConnections​

Secondary replicas connection mode

Database​

An SQL Server database.

For more information, see the Concepts section of the documentation.

name : string​

Name of the database.

clusterId : string​

ID of the SQL Server cluster that the database belongs to.

DatabaseSpec​

name : string​

Name of the database.

Host​

Role​

  • ROLE_UNKNOWN

    Role of the host in the cluster is unknown.

  • MASTER

    Host is the master SQL Server instance in the cluster.

  • REPLICA

    Host is a replica SQL Server instance in the cluster.

Health​

  • HEALTH_UNKNOWN

    Health of the host is unknown.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable and cannot perform any of its essential functions.

  • DEGRADED

    The host is degraded and can perform only some of its essential functions.

name : string​

Name of the SQL Server host.

The host name is assigned by Managed Service for SQL Server at the moment of creation and cannot be changed. 1-63 characters long.

The name is unique across all database hosts that exist on the platform as it defines the FQDN of the host.

clusterId : string​

ID of the SQL Server host.

The ID is assigned by Managed Service for SQL Server at the moment of creation.

zoneId : string​

ID of the availability zone where the SQL Server host resides.

resources : Resources​

Resources allocated to the host.

role : Role​

Role of the host in the cluster.

health : Health​

Status code of the aggregated health of the host.

services : Service​

Services provided by the host.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Flag showing public IP assignment status to this host.

Monitoring​

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the SQL Server cluster.

Permission​

Role​

Role granted to the user within the database.

  • ROLE_UNSPECIFIED

    Role granted to the user within the database.

  • DB_OWNER

    Members of this fixed database role can perform all configuration and maintenance activities on a database and can also drop a database in SQL Server.

  • DB_SECURITYADMIN

    Members of this fixed database role can modify role membership for custom roles only and manage permissions. They can potentially elevate their privileges and their actions should be monitored.

  • DB_ACCESSADMIN

    Members of this fixed database role can add or remove access to a database for Windows logins, Windows groups, and SQL Server logins.

  • DB_BACKUPOPERATOR

    Members of this fixed database role can back up the database.

  • DB_DDLADMIN

    Members of this fixed database role can run any Data Definition Language (DDL) command in a database.

  • DB_DATAWRITER

    Members of this fixed database role can add, delete, or change data in all user tables.

  • DB_DATAREADER

    Members of this fixed database role can read all data from all user tables.

  • DB_DENYDATAWRITER

    Members of this fixed database role cannot add, modify, or delete any data in the user tables within a database. A denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles.

  • DB_DENYDATAREADER

    Members of this fixed database role cannot read any data in the user tables within a database. A denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles.

databaseName : string​

Name of the database the permission grants access to.

roles : Role​

Roles granted to the user within the database.

ResourcePreset​

A preset of resources for hardware configuration of SQL Server hosts.

id : string​

ID of the resource preset.

zoneIds : string​

IDs of availability zones where the resource preset is available.

cores : int64​

Number of CPU cores for an SQL Server host created with the preset.

memory : int64​

RAM volume for an SQL Server host created with the preset, in bytes.

Resources​

resourcePresetId : string​

ID of the preset for computational resources available to a host (CPU, memory, etc.).

All available presets are listed in the documentation.

diskSize : int64​

Volume of the storage available to a host.

diskTypeId : string​

Type of the storage environment for the host.

Possible values:

  • network-hdd - network HDD drive;
  • network-ssd - network SSD drive;
  • local-ssd - local SSD storage.

Service​

Type​

  • TYPE_UNSPECIFIED

  • SQLSERVER

    SQL Server service.

Health​

  • HEALTH_UNKNOWN

    Health of the server is unknown.

  • ALIVE

    The server is working normally.

  • DEAD

    The server is dead or unresponsive.

type : Type​

Type of the service provided by the host.

health : Health​

Status code of server availability.

User​

An SQL Server user.

name : string​

Name of the SQL Server user.

clusterId : string​

ID of the SQL Server cluster the user belongs to.

permissions : Permission​

Set of permissions granted to the user.

serverRoles : ServerRole​

Set of server roles granted to the login.

UserSpec​

name : string​

Name of the SQL Server user.

password : string​

Password of the SQL Server user.

permissions : Permission​

Set of permissions to grant to the user.

serverRoles : ServerRole​

Set of server roles.