deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	deployments
Type	Resource
Id	google.workloadmanager.deployments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Description of the deployment.
sapSystemS4Config	object	SAP system workload input. (id: SapSystemS4Config)
serviceAccount	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.
sqlServerWorkload	object	MS SQL workload input. (id: SqlServerWorkload)
state	string	Output only. Current state of the deployment. (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING, FAILED)
terraformVariables	object	Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
updateTime	string (google-datetime)	Output only. Update time stamp.
workerPool	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.
workloadType	string	Optional. Workload type of the deployment. (WORKLOAD_TYPE_UNSPECIFIED, SAP_S4, SQL_SERVER, ORACLE)

list

Name	Datatype	Description
name	string	The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	Description of the deployment.
sapSystemS4Config	object	SAP system workload input. (id: SapSystemS4Config)
serviceAccount	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.
sqlServerWorkload	object	MS SQL workload input. (id: SqlServerWorkload)
state	string	Output only. Current state of the deployment. (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING, FAILED)
terraformVariables	object	Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
updateTime	string (google-datetime)	Output only. Update time stamp.
workerPool	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.
workloadType	string	Optional. Workload type of the deployment. (WORKLOAD_TYPE_UNSPECIFIED, SAP_S4, SQL_SERVER, ORACLE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deploymentsId		Gets details of a single Deployment.
list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Lists Deployments in a given project and location.
create	insert	projectsId, locationsId	deploymentId, requestId	Creates a new Deployment in a given project and location.
delete	delete	projectsId, locationsId, deploymentsId	force	Deletes a single Deployment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deploymentsId	string
locationsId	string
projectsId	string
deploymentId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single Deployment.

SELECT
name,
createTime,
description,
sapSystemS4Config,
serviceAccount,
sqlServerWorkload,
state,
terraformVariables,
updateTime,
workerPool,
workloadType
FROM google.workloadmanager.deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required
;

list

Lists Deployments in a given project and location.

SELECT
name,
createTime,
description,
sapSystemS4Config,
serviceAccount,
sqlServerWorkload,
state,
terraformVariables,
updateTime,
workerPool,
workloadType
FROM google.workloadmanager.deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new Deployment in a given project and location.

INSERT INTO google.workloadmanager.deployments (
data__description,
data__name,
data__sapSystemS4Config,
data__serviceAccount,
data__sqlServerWorkload,
data__terraformVariables,
data__workerPool,
data__workloadType,
projectsId,
locationsId,
deploymentId,
requestId
)
SELECT 
'{{ description }}',
'{{ name }}',
'{{ sapSystemS4Config }}',
'{{ serviceAccount }}',
'{{ sqlServerWorkload }}',
'{{ terraformVariables }}',
'{{ workerPool }}',
'{{ workloadType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ deploymentId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the deployments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the deployments resource.
  - name: description
    value: "{{ description }}"
    description: |
      Description of the deployment.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.
  - name: sapSystemS4Config
    description: |
      SAP system workload input.
    value:
      allowStoppingForUpdate: {{ allowStoppingForUpdate }}
      ansibleRunnerServiceAccount: "{{ ansibleRunnerServiceAccount }}"
      app:
        appInstanceId: "{{ appInstanceId }}"
        appServiceAccount: "{{ appServiceAccount }}"
        appVmNames:
          - "{{ appVmNames }}"
        ascsImage: "{{ ascsImage }}"
        ascsInstanceId: "{{ ascsInstanceId }}"
        ascsMachineType: "{{ ascsMachineType }}"
        ascsServiceAccount: "{{ ascsServiceAccount }}"
        ascsVm: "{{ ascsVm }}"
        ersInstanceId: "{{ ersInstanceId }}"
        ersVm: "{{ ersVm }}"
        image: "{{ image }}"
        machineType: "{{ machineType }}"
        secretManagerSecret: "{{ secretManagerSecret }}"
        sharedStorage: "{{ sharedStorage }}"
        sid: "{{ sid }}"
        vmsMultiplier: {{ vmsMultiplier }}
      database:
        databaseServiceAccount: "{{ databaseServiceAccount }}"
        diskType: "{{ diskType }}"
        image: "{{ image }}"
        instanceId: "{{ instanceId }}"
        machineType: "{{ machineType }}"
        primaryDbVm: "{{ primaryDbVm }}"
        secondaryDbVm: "{{ secondaryDbVm }}"
        secretManagerSecret: "{{ secretManagerSecret }}"
        sid: "{{ sid }}"
      deploymentModel: "{{ deploymentModel }}"
      environmentType: "{{ environmentType }}"
      gcpProjectId: "{{ gcpProjectId }}"
      location:
        createCommsFirewall: {{ createCommsFirewall }}
        customTags:
          - "{{ customTags }}"
        deploymentDnsEnabled: {{ deploymentDnsEnabled }}
        dnsZone: "{{ dnsZone }}"
        dnsZoneNameSuffix: "{{ dnsZoneNameSuffix }}"
        internetAccess: "{{ internetAccess }}"
        networkProject: "{{ networkProject }}"
        regionName: "{{ regionName }}"
        subnetName: "{{ subnetName }}"
        vpcName: "{{ vpcName }}"
        zone1Name: "{{ zone1Name }}"
        zone2Name: "{{ zone2Name }}"
      mediaBucketName: "{{ mediaBucketName }}"
      sapBootDiskImage: "{{ sapBootDiskImage }}"
      scalingMethod: "{{ scalingMethod }}"
      version: "{{ version }}"
      vmPrefix: "{{ vmPrefix }}"
  - name: serviceAccount
    value: "{{ serviceAccount }}"
    description: |
      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.
  - name: sqlServerWorkload
    description: |
      MS SQL workload input.
    value:
      activeDirectory:
        dnsAddress: "{{ dnsAddress }}"
        domain: "{{ domain }}"
        domainUsername: "{{ domainUsername }}"
        secretManagerSecret: "{{ secretManagerSecret }}"
        type: "{{ type }}"
      computeEngineServiceAccount: "{{ computeEngineServiceAccount }}"
      database:
        diskType: "{{ diskType }}"
        floatingIpAddress: "{{ floatingIpAddress }}"
        machineType: "{{ machineType }}"
        secondarySoleTenantNode: "{{ secondarySoleTenantNode }}"
        secondarySoleTenantNodeType: "{{ secondarySoleTenantNodeType }}"
        secretManagerSecret: "{{ secretManagerSecret }}"
        smt: {{ smt }}
        soleTenantNode: "{{ soleTenantNode }}"
        soleTenantNodeType: "{{ soleTenantNodeType }}"
        tempdbOnSsd: {{ tempdbOnSsd }}
        tenancyModel: "{{ tenancyModel }}"
      deploymentModel: "{{ deploymentModel }}"
      environmentType: "{{ environmentType }}"
      fciType: "{{ fciType }}"
      haType: "{{ haType }}"
      isSqlPayg: {{ isSqlPayg }}
      location:
        dnsZone: "{{ dnsZone }}"
        gcpProjectId: "{{ gcpProjectId }}"
        internetAccess: "{{ internetAccess }}"
        network: "{{ network }}"
        primaryZone: "{{ primaryZone }}"
        region: "{{ region }}"
        secondaryZone: "{{ secondaryZone }}"
        subnetwork: "{{ subnetwork }}"
        tertiaryZone: "{{ tertiaryZone }}"
      mediaBucket: "{{ mediaBucket }}"
      operatingSystemType: "{{ operatingSystemType }}"
      osImage: "{{ osImage }}"
      osImageType: "{{ osImageType }}"
      pacemaker:
        bucketNameNodeCertificates: "{{ bucketNameNodeCertificates }}"
        pacemakerCluster: "{{ pacemakerCluster }}"
        pacemakerClusterSecret: "{{ pacemakerClusterSecret }}"
        pacemakerClusterUsername: "{{ pacemakerClusterUsername }}"
        sqlPacemakerSecret: "{{ sqlPacemakerSecret }}"
        sqlPacemakerUsername: "{{ sqlPacemakerUsername }}"
      sqlServerEdition: "{{ sqlServerEdition }}"
      sqlServerVersion: "{{ sqlServerVersion }}"
      vmPrefix: "{{ vmPrefix }}"
  - name: terraformVariables
    value: "{{ terraformVariables }}"
    description: |
      Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
  - name: workerPool
    value: "{{ workerPool }}"
    description: |
      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.
  - name: workloadType
    value: "{{ workloadType }}"
    description: |
      Optional. Workload type of the deployment.
    valid_values: ['WORKLOAD_TYPE_UNSPECIFIED', 'SAP_S4', 'SQL_SERVER', 'ORACLE']
  - name: deploymentId
    value: "{{ deploymentId }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes a single Deployment.

DELETE FROM google.workloadmanager.deployments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND force = '{{ force }}'
;