REST Resource: projects.locations.deployments

{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "serviceAccount": string,
  "workerPool": string,

  // Union field workload_config can be only one of the following:
  "sapSystemS4Config": {
    object (SapSystemS4Config)
  },
  "sqlServerWorkload": {
    object (SqlServerWorkload)
  }
  // End of list of possible types for union field workload_config.
}

string

The name of deployment resource. The format will be 'projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'

string

Description of the Deployment

string (Timestamp format)

Output only. [Output only] Create time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. [Output only] Update time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

enum (State)

Output only. Current state of the deployment.

string

User-specified Service Account (SA) credentials to be used for cloud build Format: projects/{projectID}/serviceAccounts/{serviceAccount} The default Cloud Build SA will be used initially if this field is not set during deployment creation

string

Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId}. If this field is unspecified, the default Cloud Build worker pool will be used.

object (SapSystemS4Config)

SAP system workload input

object (SqlServerWorkload)

MS SQL workload input

{
  "gcpProjectId": string,
  "location": {
    object (LocationDetails)
  },
  "database": {
    object (DatabaseDetails)
  },
  "app": {
    object (AppDetails)
  },
  "allowStoppingForUpdate": boolean,
  "version": enum (Version),
  "environmentType": enum (EnvironmentType),
  "deploymentModel": enum (DeploymentModel),
  "scalingMethod": enum (ScalingMethod),
  "mediaBucketName": string,
  "sapBootDiskImage": string,
  "vmPrefix": string,
  "ansibleRunnerServiceAccount": string
}

string

the project that infrastructure deployed, current only support the same project where the deployment resource exist.

object (LocationDetails)

database details

object (DatabaseDetails)

database details

object (AppDetails)

instance details

boolean

enum (Version)

Required. sap hana version

enum (EnvironmentType)

Required. deployment environment

enum (DeploymentModel)

Required. two model non-HA and HA supported

enum (ScalingMethod)

Required. support scale up and scale out

string

Required. mediaBucketName

string

Optional. sapBootDiskImage

string

vmPrefix

string

Ansible runner service account - let custoemrs bring their own SA for Ansible runner

{
  "vpcName": string,
  "zone1Name": string,
  "zone2Name": string,
  "dnsZoneNameSuffix": string,
  "regionName": string,
  "internetAccess": enum (InternetAccess),
  "subnetName": string,
  "dnsZone": string,
  "networkProject": string,
  "createCommsFirewall": boolean
}

string

Required. vpcName

string

Required. zone1Name

string

Optional. zone2Name

string

Optional. dnsZoneNameSuffix

string

Required. regionName

enum (InternetAccess)

string

Required. subnetName

string

Optional. dns zone name

string

Optional. network project

boolean

Optional. create firewall, if true, create firewall for the deployment. This field provides an option to not always create firewall for the deployment.

{
  "sid": string,
  "machineType": string,
  "diskType": string,
  "secretManagerSecret": string,
  "image": string,
  "instanceId": string,
  "primaryDbVm": string,
  "secondaryDbVm": string,
  "databaseServiceAccount": string
}

string

Required. The SID is a three-digit server-specific unique identification code.

string

Required. machine type

string

Required. diskType

string

Required. secretManagerSecret

string

Required. image for database server

string

Optional. instance id

string

Optional. primary db vm name

string

Optional. secondary db vm name

string

Database service account - let custoemrs bring their own SA for database

{
  "sid": string,
  "vmsMultiplier": integer,
  "machineType": string,
  "ascsMachineType": string,
  "secretManagerSecret": string,
  "image": string,
  "ascsInstanceId": string,
  "ersInstanceId": string,
  "appInstanceId": string,
  "ascsVm": string,
  "ersVm": string,
  "ascsImage": string,
  "ascsServiceAccount": string,
  "appServiceAccount": string
}

string

Required. The SAP SID is a three-digit server-specific unique identification code.

integer

Required. vmsMultiplier

string

Required. machine type

string

Required. ascsMachineType

string

Required. secretManagerSecret

string

Required. image for app server and ascs server

string

Optional. instance id for ascs

string

Optional. instance id for ers

string

Optional. instance id for app

string

Optional. ASCS vm name

string

Optional. ERS vm name

string

Required. image for ascs server

string

ASCS service account - let custoemrs bring their own SA for ASCS

string

Application service account - let custoemrs bring their own SA for application

{
  "environmentType": enum (EnvironmentType),
  "operatingSystemType": enum (OperatingSystemType),
  "osImage": string,
  "deploymentModel": enum (DeploymentModel),
  "haType": enum (HAType),
  "vmPrefix": string,
  "mediaBucket": string,
  "location": {
    object (SqlLocationDetails)
  },
  "activeDirectory": {
    object (ActiveDirectory)
  },
  "database": {
    object (Database)
  },
  "pacemaker": {
    object (Pacemaker)
  },
  "fciType": enum (FciType),
  "isSqlPayg": boolean,
  "sqlServerEdition": enum (SqlServerEditionType),
  "sqlServerVersion": enum (SqlServerVersionType),
  "osImageType": enum (OsImageType)
}

enum (EnvironmentType)

Required. deployment environment

enum (OperatingSystemType)

Required. type of the operating system the SQL server is going to run on top of

string

Required. the image of the operating system

enum (DeploymentModel)

Required. HIGH_AVAILABILITY or SINGLE_INSTANCE

enum (HAType)

Optional. AOAG or FCI, it is only needed for High Availability deployment mode

string

Required. should be unique in the project

string

Required. name of the media storing SQL server installation files

object (SqlLocationDetails)

Required. location details

object (ActiveDirectory)

Required. active directory details

object (Database)

Required. database details

object (Pacemaker)

Optional. pacemaker configuration, only applicable for Linux HA deployments

enum (FciType)

Optional. SHARED_DISK or S2D

boolean

Required. SQL licensing type

enum (SqlServerEditionType)

Optional. SQL Server Edition type, only applicable when Operating System is Linux

enum (SqlServerVersionType)

Optional. 2017 or 2019 or 2022

enum (OsImageType)

Optional. OS image type, it's used to create boot disks for VM instances When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and default to custom image

{
  "gcpProjectId": string,
  "region": string,
  "primaryZone": string,
  "secondaryZone": string,
  "network": string,
  "subnetwork": string,
  "internetAccess": enum (InternetAccess),
  "dnsZone": string,
  "tertiaryZone": string
}

string

Required. the project that infrastructure deployed, currently only supports the same project where the deployment resource exists.

string

Required. region name

string

Required. primary zone

string

Optional. secondary zone can't be same as primaryZone and is only for High Availability deployment mode

string

Required. network name

string

Required. subnetwork name

enum (InternetAccess)

Required. Internet Access

string

Optional. create a new DNS Zone when the field is empty, Only show for Using an existing DNS List of existing DNS Zones tf variable name: existing_dns_zone_name

string

Optional. teriary zone can't be same as primaryZone and secondary zone, and it is only for High Availability deployment mode

{
  "type": enum (ActiveDirectoryType),
  "domainUsername": string,
  "secretManagerSecret": string,
  "dnsAddress": string,
  "domain": string
}

enum (ActiveDirectoryType)

Required. active directory type

string

Optional. domain username

string

Required. secretManagerSecret

string

Optional. DNS IP address

string

Optional. human readable form of a domain such as “google.com”.

{
  "secretManagerSecret": string,
  "floatingIpAddress": string,
  "machineType": string,
  "smt": boolean,
  "tempdbOnSsd": boolean,
  "tenancyModel": enum (TenancyModel),
  "soleTenantNode": string,
  "soleTenantNodeType": string
}

string

Required. secretManagerSecret

string

Optional. only useful for Linux High Availability setup

string

Required. machine type

boolean

Required. whether simultaneous multithreading is enabled or not

boolean

Required. whether to have TempDB on local SSD

enum (TenancyModel)

Required. SHARED or SOLE_TENANT

string

Optional. the name of a sole-tenant node/node group

string

Optional. the type of a sole-tenant node/node group e.g. compute.googleapis.com/node-name

{
  "pacemakerCluster": string,
  "pacemakerClusterUsername": string,
  "pacemakerClusterSecret": string,
  "sqlPacemakerUsername": string,
  "sqlPacemakerSecret": string,
  "bucketNameNodeCertificates": string
}

string

Required. pacemaker cluster name

string

Required. pacemaker cluster username

string

Required. pacemaker cluster secret name

string

Required. sql pacemaker username

string

Required. sql pacemaker secret name

string

Required. bucket location for node certificates