sandbox_environment_templates

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

Overview

Name	sandbox_environment_templates
Type	Resource
Id	google.aiplatform.sandbox_environment_templates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the SandboxEnvironmentTemplate. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}
createTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironmentTemplate was created.
customContainerEnvironment	object	The sandbox environment for custom container workloads. (id: GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment)
defaultContainerEnvironment	object	The sandbox environment for default container workloads. (id: GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment)
displayName	string	Required. The display name of the SandboxEnvironmentTemplate.
egressControlConfig	object	Optional. The configuration for egress control of this template. (id: GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig)
ingressControlConfig	object	Optional. The configuration for private ingress (PSC-E) of this template. When set, the sandbox router is exposed privately via a PSC service attachment so VPC-SC customers can connect from their VPC over a private endpoint instead of the public internet. The resulting service attachment is surfaced on SandboxEnvironment.connection_info.service_attachment. Only the PSC-E (service-attachment/ingress) portion of PrivateServiceConnectConfig applies here: enable_private_service_connect and project_allowlist (the consumer projects allowed to connect). The nested psc_interface_config (PSC-I / egress) is not used for sandbox ingress; sandbox egress is configured via egress_control_config instead. (id: GoogleCloudAiplatformV1PrivateServiceConnectConfig)
state	string	Output only. The state of the sandbox environment template. (UNSPECIFIED, PROVISIONING, ACTIVE, DEPROVISIONING, DELETED, FAILED)
updateTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the SandboxEnvironmentTemplate. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}
createTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironmentTemplate was created.
customContainerEnvironment	object	The sandbox environment for custom container workloads. (id: GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment)
defaultContainerEnvironment	object	The sandbox environment for default container workloads. (id: GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment)
displayName	string	Required. The display name of the SandboxEnvironmentTemplate.
egressControlConfig	object	Optional. The configuration for egress control of this template. (id: GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig)
ingressControlConfig	object	Optional. The configuration for private ingress (PSC-E) of this template. When set, the sandbox router is exposed privately via a PSC service attachment so VPC-SC customers can connect from their VPC over a private endpoint instead of the public internet. The resulting service attachment is surfaced on SandboxEnvironment.connection_info.service_attachment. Only the PSC-E (service-attachment/ingress) portion of PrivateServiceConnectConfig applies here: enable_private_service_connect and project_allowlist (the consumer projects allowed to connect). The nested psc_interface_config (PSC-I / egress) is not used for sandbox ingress; sandbox egress is configured via egress_control_config instead. (id: GoogleCloudAiplatformV1PrivateServiceConnectConfig)
state	string	Output only. The state of the sandbox environment template. (UNSPECIFIED, PROVISIONING, ACTIVE, DEPROVISIONING, DELETED, FAILED)
updateTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, reasoningEnginesId, sandboxEnvironmentTemplatesId		Gets details of the specific SandboxEnvironmentTemplate.
list	select	projectsId, locationsId, reasoningEnginesId	filter, pageSize, pageToken	Lists SandboxEnvironmentTemplates in a given reasoning engine.
create	insert	projectsId, locationsId, reasoningEnginesId		Creates a SandboxEnvironmentTemplate in a given reasoning engine.
delete	delete	projectsId, locationsId, reasoningEnginesId, sandboxEnvironmentTemplatesId		Deletes the specific SandboxEnvironmentTemplate.

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
locationsId	string
projectsId	string
reasoningEnginesId	string
sandboxEnvironmentTemplatesId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets details of the specific SandboxEnvironmentTemplate.

SELECT
name,
createTime,
customContainerEnvironment,
defaultContainerEnvironment,
displayName,
egressControlConfig,
ingressControlConfig,
state,
updateTime
FROM google.aiplatform.sandbox_environment_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' -- required
AND sandboxEnvironmentTemplatesId = '{{ sandboxEnvironmentTemplatesId }}' -- required
;

list

Lists SandboxEnvironmentTemplates in a given reasoning engine.

SELECT
name,
createTime,
customContainerEnvironment,
defaultContainerEnvironment,
displayName,
egressControlConfig,
ingressControlConfig,
state,
updateTime
FROM google.aiplatform.sandbox_environment_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a SandboxEnvironmentTemplate in a given reasoning engine.

INSERT INTO google.aiplatform.sandbox_environment_templates (
data__customContainerEnvironment,
data__defaultContainerEnvironment,
data__displayName,
data__egressControlConfig,
data__ingressControlConfig,
data__name,
projectsId,
locationsId,
reasoningEnginesId
)
SELECT 
'{{ customContainerEnvironment }}',
'{{ defaultContainerEnvironment }}',
'{{ displayName }}',
'{{ egressControlConfig }}',
'{{ ingressControlConfig }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ reasoningEnginesId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: sandbox_environment_templates
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the sandbox_environment_templates resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the sandbox_environment_templates resource.
  - name: reasoningEnginesId
    value: "{{ reasoningEnginesId }}"
    description: Required parameter for the sandbox_environment_templates resource.
  - name: customContainerEnvironment
    description: |
      The sandbox environment for custom container workloads.
    value:
      customContainerSpec:
        imageUri: "{{ imageUri }}"
      ports:
        - port: {{ port }}
          protocol: "{{ protocol }}"
      resources:
        limits: "{{ limits }}"
        requests: "{{ requests }}"
  - name: defaultContainerEnvironment
    description: |
      The sandbox environment for default container workloads.
    value:
      defaultContainerCategory: "{{ defaultContainerCategory }}"
      resources:
        limits: "{{ limits }}"
        requests: "{{ requests }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name of the SandboxEnvironmentTemplate.
  - name: egressControlConfig
    description: |
      Optional. The configuration for egress control of this template.
    value:
      customerVpcNetwork: "{{ customerVpcNetwork }}"
      dnsPeeringConfigs:
        - domain: "{{ domain }}"
          targetNetwork: "{{ targetNetwork }}"
          targetProject: "{{ targetProject }}"
      internetAccess: {{ internetAccess }}
      networkAttachment: "{{ networkAttachment }}"
  - name: ingressControlConfig
    description: |
      Optional. The configuration for private ingress (PSC-E) of this template. When set, the sandbox router is exposed privately via a PSC service attachment so VPC-SC customers can connect from their VPC over a private endpoint instead of the public internet. The resulting service attachment is surfaced on `SandboxEnvironment.connection_info.service_attachment`. Only the PSC-E (service-attachment/ingress) portion of `PrivateServiceConnectConfig` applies here: `enable_private_service_connect` and `project_allowlist` (the consumer projects allowed to connect). The nested `psc_interface_config` (PSC-I / egress) is not used for sandbox ingress; sandbox egress is configured via `egress_control_config` instead.
    value:
      enablePrivateServiceConnect: {{ enablePrivateServiceConnect }}
      projectAllowlist:
        - "{{ projectAllowlist }}"
      pscAutomationConfigs:
        - errorMessage: "{{ errorMessage }}"
          forwardingRule: "{{ forwardingRule }}"
          ipAddress: "{{ ipAddress }}"
          network: "{{ network }}"
          projectId: "{{ projectId }}"
          state: "{{ state }}"
      serviceAttachment: "{{ serviceAttachment }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`

DELETE examples

delete

Deletes the specific SandboxEnvironmentTemplate.

DELETE FROM google.aiplatform.sandbox_environment_templates
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' --required
AND sandboxEnvironmentTemplatesId = '{{ sandboxEnvironmentTemplatesId }}' --required
;