deployment_groups

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

Overview

Name	deployment_groups
Type	Resource
Id	google.config.deployment_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
annotations	object	Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
createTime	string (google-datetime)	Output only. Time when the deployment group was created.
deploymentUnits	array	The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.
labels	object	Optional. User-defined metadata for the deployment group.
provisioningError	object	Output only. The error status of the deployment group provisioning or deprovisioning. (id: Status)
provisioningState	string	Output only. The provisioning state of the deployment group. (PROVISIONING_STATE_UNSPECIFIED, PROVISIONING, PROVISIONED, FAILED_TO_PROVISION, DEPROVISIONING, DEPROVISIONED, FAILED_TO_DEPROVISION)
provisioningStateDescription	string	Output only. Additional information regarding the current provisioning state.
state	string	Output only. Current state of the deployment group. (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING, FAILED, SUSPENDED, DELETED)
stateDescription	string	Output only. Additional information regarding the current state.
updateTime	string (google-datetime)	Output only. Time when the deployment group was last updated.

list

Name	Datatype	Description
name	string	Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
annotations	object	Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
createTime	string (google-datetime)	Output only. Time when the deployment group was created.
deploymentUnits	array	The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.
labels	object	Optional. User-defined metadata for the deployment group.
provisioningError	object	Output only. The error status of the deployment group provisioning or deprovisioning. (id: Status)
provisioningState	string	Output only. The provisioning state of the deployment group. (PROVISIONING_STATE_UNSPECIFIED, PROVISIONING, PROVISIONED, FAILED_TO_PROVISION, DEPROVISIONING, DEPROVISIONED, FAILED_TO_DEPROVISION)
provisioningStateDescription	string	Output only. Additional information regarding the current provisioning state.
state	string	Output only. Current state of the deployment group. (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING, FAILED, SUSPENDED, DELETED)
stateDescription	string	Output only. Additional information regarding the current state.
updateTime	string (google-datetime)	Output only. Time when the deployment group was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deploymentGroupsId		Get a DeploymentGroup for a given project and location.
list	select	projectsId, locationsId	pageSize, filter, pageToken, orderBy	List DeploymentGroups for a given project and location.
create	insert	projectsId, locationsId	deploymentGroupId, requestId	Creates a DeploymentGroup The newly created DeploymentGroup will be in the CREATING state and can be retrieved via Get and List calls.
patch	update	projectsId, locationsId, deploymentGroupsId	updateMask, requestId	Updates a DeploymentGroup
delete	delete	projectsId, locationsId, deploymentGroupsId	requestId, deploymentReferencePolicy, force	Deletes a DeploymentGroup
provision	exec	projectsId, locationsId, deploymentGroupsId		Provisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the last successful DeploymentGroupRevision but are no longer included in the current DeploymentGroup definition (e.g., following an UpdateDeploymentGroup call), along with their actuated resources.
deprovision	exec	projectsId, locationsId, deploymentGroupsId		Deprovisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the last successful DeploymentGroupRevision but are no longer included in the current DeploymentGroup definition (e.g., following an UpdateDeploymentGroup call), along with their actuated resources.

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
deploymentGroupsId	string
locationsId	string
projectsId	string
deploymentGroupId	string
deploymentReferencePolicy	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get a DeploymentGroup for a given project and location.

SELECT
name,
annotations,
createTime,
deploymentUnits,
labels,
provisioningError,
provisioningState,
provisioningStateDescription,
state,
stateDescription,
updateTime
FROM google.config.deployment_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deploymentGroupsId = '{{ deploymentGroupsId }}' -- required
;

list

List DeploymentGroups for a given project and location.

SELECT
name,
annotations,
createTime,
deploymentUnits,
labels,
provisioningError,
provisioningState,
provisioningStateDescription,
state,
stateDescription,
updateTime
FROM google.config.deployment_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a DeploymentGroup The newly created DeploymentGroup will be in the CREATING state and can be retrieved via Get and List calls.

INSERT INTO google.config.deployment_groups (
data__deploymentUnits,
data__name,
data__labels,
data__annotations,
projectsId,
locationsId,
deploymentGroupId,
requestId
)
SELECT 
'{{ deploymentUnits }}',
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ deploymentGroupId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: deployment_groups
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the deployment_groups resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the deployment_groups resource.
  - name: deploymentUnits
    description: |
      The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.
    value:
      - dependencies: "{{ dependencies }}"
        id: "{{ id }}"
        deployment: "{{ deployment }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined metadata for the deployment group.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
  - name: deploymentGroupId
    value: "{{ deploymentGroupId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates a DeploymentGroup

UPDATE google.config.deployment_groups
SET 
data__deploymentUnits = '{{ deploymentUnits }}',
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deploymentGroupsId = '{{ deploymentGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a DeploymentGroup

DELETE FROM google.config.deployment_groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deploymentGroupsId = '{{ deploymentGroupsId }}' --required
AND requestId = '{{ requestId }}'
AND deploymentReferencePolicy = '{{ deploymentReferencePolicy }}'
AND force = '{{ force }}'
;

Lifecycle Methods

provision

Provisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the last successful DeploymentGroupRevision but are no longer included in the current DeploymentGroup definition (e.g., following an UpdateDeploymentGroup call), along with their actuated resources.

EXEC google.config.deployment_groups.provision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deploymentGroupsId='{{ deploymentGroupsId }}' --required 
@@json=
'{
"deploymentSpecs": "{{ deploymentSpecs }}"
}'
;

deprovision

Deprovisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the last successful DeploymentGroupRevision but are no longer included in the current DeploymentGroup definition (e.g., following an UpdateDeploymentGroup call), along with their actuated resources.

EXEC google.config.deployment_groups.deprovision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deploymentGroupsId='{{ deploymentGroupsId }}' --required 
@@json=
'{
"force": {{ force }}, 
"deletePolicy": "{{ deletePolicy }}"
}'
;