Create an instance

Console

1. Go to the Cloud SQL Instances page in the Google Cloud console.

   Go to Cloud SQL Instances

2. Click Create instance.
3. On the Choose your database engine panel of the Create an instance page, click Choose SQL Server.

4. In the Choose a Cloud SQL edition section of the Create a SQL Server instance page, select the Cloud SQL edition for your instance: Enterprise or Enterprise plus.

   For more information about Cloud SQL editions, see Introduction to Cloud SQL for SQL Server editions.

5. Select the edition preset for your instance. To see the available presets, click the Edition preset menu.
6. In the Instance info section, select the database version for your instance. To see the available versions, click the Database version menu.
7. In the Instance ID field, enter an ID for your instance.

   You do not need to include the project ID in the instance name. This is done automatically where appropriate (for example, in the log files).

8. In the Password field, enter a password for the user.
9. In the Choose region and zonal availability section, select the region and zone for your instance.

   Place your instance in the same region as the resources that access it. The region you select can't be modified in the future. In most cases, you don't need to specify a zone.

10. In the Customize your instance section, update the settings for your instance. For example, you can prevent accidental instance deletion.
11. Click Create instance.
12. After the initialization process of the instance completes, click the instance name to open it.

gcloud

For information about installing and getting started with the gcloud CLI, see Installing gcloud CLI. For information about starting Cloud Shell, see the Cloud Shell documentation.

You must use gcloud version 243.0.0 or later.

For information about protecting an instance against accidental deletion, see Prevent deletion of an instance.

1. Create the instance:
   For Cloud SQL Enterprise Plus edition instances:

   gcloud sql instances create INSTANCE_NAME \
   --database-version=DATABASE_VERSION \
   --region=REGION \
   --tier=TIER \
   --root-password=ROOT_PASSWORD
   --edition=ENTERPRISE_PLUS

   For Cloud SQL Enterprise edition instances:

   gcloud sql instances create INSTANCE_NAME \
   --database-version=DATABASE_VERSION \
   --region=REGION \
   --cpu=NUMBER_OF_vCPUs \
   --memory=MEMORY_SIZE \
   --root-password=ROOT_PASSWORD
   --edition=ENTERPRISE

   You do not need to include the project ID in the instance name. This is done automatically where appropriate (for example, in the log files).

   As noted earlier on this page, the values for vCPUs and memory size are limited for Cloud SQL Enterprise edition. See Choose between Cloud SQL Enterprise Plus edition and Cloud SQL Enterprise edition.

   For example, the following string creates an instance with two vCPUs and 7,680 MB of memory:

   gcloud sql instances create myinstance \
   --database-version=SQLSERVER_2017_STANDARD \
   --region=us-central1 \
   --cpu=2 \
   --memory=7680MB \
   --root-password=EXAMPLE_PASSWORD
   --edition=ENTERPRISE

   For some sample values, see Sample machine types.

   To learn about the parameters for instance settings, see gcloud sql instances create.

2. Note the automatically-assigned IP address.

   If you are not using the Cloud SQL Auth Proxy, you will use this address as the host address that your applications or tools use to connect to the instance.

3. Set the password for the user:

   gcloud sql users set-password sqlserver no-host --instance=[INSTANCE_NAME] \
          --password=[PASSWORD]

Terraform

To create an instance, use a Terraform resource.

resource "google_sql_database_instance" "instance" {
  name             = "sqlserver-instance"
  region           = "us-central1"
  database_version = "SQLSERVER_2019_STANDARD"
  root_password    = "INSERT-PASSWORD-HERE"
  settings {
    tier = "db-custom-2-7680"
  }
  # set `deletion_protection` to true, will ensure that one cannot accidentally delete this instance by
  # use of Terraform whereas `deletion_protection_enabled` flag protects this instance at the GCP level.
  deletion_protection = false
}

REST v1

1. Create the instance

Not all possible fields are shown in the basic API call below. For a prototype of a JSON request, see Settings.

Also see the Instances:insert page. For information about instance settings, including valid values for regions, see Instance settings. For information about machine types, see Custom instance configurations.

Do not include sensitive or personally identifiable information in instance-id; the value is externally visible.

You do not need to include the project ID in the instance name. This is done automatically where appropriate (for example, in the log files).

The collation field (not shown in the basic API call below) enables you to set a default value for the type of collation used for the databases in your instance. This collation default is permanent at the instance level but not at the database level. You can change this default with a database administration tool, but only for a specific database that you are creating or updating. You cannot change the collation default for an instance after creating the instance (unless you recreate the instance). For information about collations in SQL Server, see Collation and Unicode support. For a prototype of a JSON request, see Settings. Here is an example string you could specify for the collation parameter: SQL_Latin1_General_CP1_CI_AS.

The timeZone field (not shown in the basic API call below) lets you to set a time zone for an instance. After you create an instance, you can change the time zone of an instance. For more information and a list of accepted strings, see Settings. Here is an example string you could specify for the timeZone field: "Pacific Standard Time". See more.

To create an instance that is integrated with Managed Microsoft AD, specify a domain, such as subdomain.mydomain.com, for the domain field. For more information, see Creating an instance with Windows Authentication. Additionally, note the procedures and constraints for integrating with a managed AD domain in a different project.

Before using any of the request data, make the following replacements:

• PROJECT_ID: your project ID.
• INSTANCE_ID: the instance ID.
• REGION: the region name.
• DATABASE_VERSION: an enum string of the database version. For example: SQLSERVER_2017_STANDARD.
• PASSWORD: the password for the root user.
• MACHINE_TYPE: an enum string of the machine (tier) type. For example:
  db-perf-optimized-N-4.
• EDITION_TYPE: your Cloud SQL edition. The default value is ENTERPRISE.
• DATA_CACHE_ENABLED: (optional) to enable Data cache for your instance, set the value of this parameter to true.

HTTP method and URL:

POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances

Request JSON body:

{
  "name": "INSTANCE_ID",
  "region": "REGION",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "backupConfiguration": {
      "enabled": true
    },
    "dataCacheConfig" = {
      "dataCacheEnabled": DATA_CACHE_ENABLED
    },
  }
}

To send your request, expand one of these options:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-01T19:13:21.834Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

After the instance is created, you can further configure the default user account.

2. Retrieve the IPv4 address of the instance

Optionally, you can retrieve the automatically-assigned IPv4 address. In the response, that address is in the ipAddress field.

Before using any of the request data, make the following replacements:

• PROJECT_ID: your project ID
• INSTANCE_ID: your instance ID, created in the previous step

HTTP method and URL:

GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID

To send your request, expand one of these options:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "kind": "sql#instance",
  "state": "RUNNABLE",
  "databaseVersion": "DATABASE_VERSION",
  "settings": {
    "authorizedGaeApplications": [],
    "tier": "MACHINE_TYPE",
    "kind": "sql#settings",
    "pricingPlan": "PER_USE",
    "replicationType": "SYNCHRONOUS",
    "activationPolicy": "ALWAYS",
    "ipConfiguration": {
      "authorizedNetworks": [],
      "ipv4Enabled": true
    },
    "locationPreference": {
      "zone": "ZONE",
      "kind": "sql#locationPreference"
    },
    "dataDiskType": "PD_SSD",
    "backupConfiguration": {
      "startTime": "19:00",
      "kind": "sql#backupConfiguration",
      "enabled": true
    },
    "settingsVersion": "1",
    "dataDiskSizeGb": "10"
  },
  "etag": "--redacted--",
  "ipAddresses": [
    {
      "type": "PRIMARY",
      "ipAddress": "10.0.0.1"
    }
  ],
  "serverCaCert": {
    ...
  },
  "instanceType": "CLOUD_SQL_INSTANCE",
  "project": "PROJECT_ID",
  "serviceAccountEmailAddress": "redacted@gcp-sa-cloud-sql.iam.gserviceaccount.com",
  "backendType": "BACKEND_TYPE",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID",
  "connectionName": "PROJECT_ID:REGION:INSTANCE_ID",
  "name": "INSTANCE_ID",
  "region": "REGION",
  "gceZone": "ZONE"
}

REST v1beta4

1. Create the instance

Not all possible fields are shown in the basic API call below. For a prototype of a JSON request, see Settings.

Also see the Instances:insert page. For information about instance settings, including valid values for regions, see Instance settings. For information about machine types, see Custom instance configurations.

Do not include sensitive or personally identifiable information in instance-id; the value is externally visible.

You do not need to include the project ID in the instance name. This is done automatically where appropriate (for example, in the log files).

The collation field (not shown in the basic API call below) enables you to set a default value for the type of collation used for the databases in your instance. This collation default is permanent at the instance level but not at the database level. You can change this default with a database administration tool, but only for a specific database that you are creating or updating. You cannot change the collation default for an instance after creating the instance (unless you recreate the instance). For information about collations in SQL Server, see Collation and Unicode support. For a prototype of a JSON request, see Settings. Here is an example string you could specify for the collation parameter: SQL_Latin1_General_CP1_CI_AS.

The timeZone field (not shown in the basic API call below) lets you to set a time zone for an instance. After you create an instance, you can change the time zone of an instance. For more information and a list of accepted strings, see Settings. Here is an example string you could specify for the timeZone field: "Pacific Standard Time". See more.

To create an instance that is integrated with Managed Microsoft AD, specify a domain, such as subdomain.mydomain.com, for the domain field. For more information, see Creating an instance with Windows Authentication. Additionally, note the procedures and constraints for integrating with a managed AD domain in a different project.

Before using any of the request data, make the following replacements:

• PROJECT_ID: your project ID.
• INSTANCE_ID: the instance ID.
• REGION: the region name.
• DATABASE_VERSION: an enum string of the database version.
• MACHINE_TYPE: an enum string of the machine (tier) type. For example:
  db-perf-optimized-N-4.
• PASSWORD: the password for the root user.
• MACHINE_TYPE: an enum string of the machine (tier) type, as: db-custom-[CPUS]-[MEMORY_MBS].
• EDITION_TYPE: your Cloud SQL edition. The default value is ENTERPRISE.
• DATA_CACHE_ENABLED: (optional) to enable Data cache for your instance, set the value of this parameter to true.

HTTP method and URL:

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances

Request JSON body:

{
  "name": "INSTANCE_ID",
  "region": "REGION",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "backupConfiguration": {
      "enabled": true
    },
    "dataCacheConfig" = {
      "dataCacheEnabled": DATA_CACHE_ENABLED
    },
  }
}

To send your request, expand one of these options:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-01T19:13:21.834Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

After the instance is created, you can further configure the default user account.

2. Retrieve the IPv4 address of the instance

Optionally, you can retrieve the automatically-assigned IPv4 address. In the response, that address is in the ipAddress field.

Before using any of the request data, make the following replacements:

• PROJECT_ID: your project ID
• INSTANCE_ID: your instance ID, created in the previous step

HTTP method and URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

To send your request, expand one of these options:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "kind": "sql#instance",
  "state": "RUNNABLE",
  "databaseVersion": "DATABASE_VERSION",
  "settings": {
    "authorizedGaeApplications": [],
    "tier": "MACHINE_TYPE",
    "kind": "sql#settings",
    "pricingPlan": "PER_USE",
    "replicationType": "SYNCHRONOUS",
    "activationPolicy": "ALWAYS",
    "ipConfiguration": {
      "authorizedNetworks": [],
      "ipv4Enabled": true
    },
    "locationPreference": {
      "zone": "ZONE",
      "kind": "sql#locationPreference"
    },
    "dataDiskType": "PD_SSD",
    "backupConfiguration": {
      "startTime": "19:00",
      "kind": "sql#backupConfiguration",
      "enabled": true
    },
    "settingsVersion": "1",
    "dataDiskSizeGb": "10"
  },
  "etag": "--redacted--",
  "ipAddresses": [
    {
      "type": "PRIMARY",
      "ipAddress": "10.0.0.1"
    }
  ],
  "serverCaCert": {
    ...
  },
  "instanceType": "CLOUD_SQL_INSTANCE",
  "project": "PROJECT_ID",
  "serviceAccountEmailAddress": "redacted@gcp-sa-cloud-sql.iam.gserviceaccount.com",
  "backendType": "BACKEND_TYPE",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID",
  "connectionName": "PROJECT_ID:REGION:INSTANCE_ID",
  "name": "INSTANCE_ID",
  "region": "REGION",
  "gceZone": "ZONE"
}