environments

Creates, updates, deletes, gets or lists an environments resource.

Overview

Name	environments
Type	Resource
Id	google.cloudshell.environments

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string	Output only. The environment's identifier, unique among the user's environments.
name	string	Immutable. Full name of this resource, in the format users/{owner_email}/environments/{environment_id}. {owner_email} is the email address of the user to whom this environment belongs, and {environment_id} is the identifier of this environment. For example, users/someone@example.com/environments/default.
dockerImage	string	Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
publicKeys	array	Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods.
sshHost	string	Output only. Host to which clients can connect to initiate SSH sessions with the environment.
sshPort	integer (int32)	Output only. Port to which clients can connect to initiate SSH sessions with the environment.
sshUsername	string	Output only. Username that clients should use when initiating SSH sessions with the environment.
state	string	Output only. Current execution state of this environment.
webHost	string	Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	usersId, environmentsId		Gets an environment. Returns NOT_FOUND if the environment does not exist.
start	exec	usersId, environmentsId		Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.
authorize	exec	usersId, environmentsId		Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

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
environmentsId	string
usersId	string

SELECT examples

get

Gets an environment. Returns NOT_FOUND if the environment does not exist.

SELECT
id,
name,
dockerImage,
publicKeys,
sshHost,
sshPort,
sshUsername,
state,
webHost
FROM google.cloudshell.environments
WHERE usersId = '{{ usersId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;

Lifecycle Methods

start

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

EXEC google.cloudshell.environments.start 
@usersId='{{ usersId }}' --required, 
@environmentsId='{{ environmentsId }}' --required 
@@json=
'{
"accessToken": "{{ accessToken }}", 
"publicKeys": "{{ publicKeys }}"
}';

authorize

Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

EXEC google.cloudshell.environments.authorize 
@usersId='{{ usersId }}' --required, 
@environmentsId='{{ environmentsId }}' --required 
@@json=
'{
"accessToken": "{{ accessToken }}", 
"idToken": "{{ idToken }}", 
"expireTime": "{{ expireTime }}"
}';