Google Cloud Native v0.28.0, Feb 2 23

google-native.notebooks/v1.getEnvironment

Gets details of a single Environment.

Using getEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>

def get_environment(environment_id: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_id: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:notebooks/v1:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

EnvironmentId string
Location string
Project string

EnvironmentId string
Location string
Project string

environmentId String
location String
project String

environmentId string
location string
project string

environment_id str
location str
project str

environmentId String
location String
project String

getEnvironment Result

The following output properties are available:

ContainerImage Pulumi.GoogleNative.Notebooks.V1.Outputs.ContainerImageResponse: Use a container image to start the notebook instance.
CreateTime string: The time at which this environment was created.
Description string: A brief description of this environment.
DisplayName string: Display name of this environment for the UI.
Name string: Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
PostStartupScript string: Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"
VmImage Pulumi.GoogleNative.Notebooks.V1.Outputs.VmImageResponse: Use a Compute Engine VM image to start the notebook instance.

ContainerImage ContainerImageResponse: Use a container image to start the notebook instance.
CreateTime string: The time at which this environment was created.
Description string: A brief description of this environment.
DisplayName string: Display name of this environment for the UI.
Name string: Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
PostStartupScript string: Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"
VmImage VmImageResponse: Use a Compute Engine VM image to start the notebook instance.

containerImage ContainerImageResponse: Use a container image to start the notebook instance.
createTime String: The time at which this environment was created.
description String: A brief description of this environment.
displayName String: Display name of this environment for the UI.
name String: Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
postStartupScript String: Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"
vmImage VmImageResponse: Use a Compute Engine VM image to start the notebook instance.

containerImage ContainerImageResponse: Use a container image to start the notebook instance.
createTime string: The time at which this environment was created.
description string: A brief description of this environment.
displayName string: Display name of this environment for the UI.
name string: Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
postStartupScript string: Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"
vmImage VmImageResponse: Use a Compute Engine VM image to start the notebook instance.

container_image ContainerImageResponse: Use a container image to start the notebook instance.
create_time str: The time at which this environment was created.
description str: A brief description of this environment.
display_name str: Display name of this environment for the UI.
name str: Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
post_startup_script str: Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"
vm_image VmImageResponse: Use a Compute Engine VM image to start the notebook instance.

containerImage Property Map: Use a container image to start the notebook instance.
createTime String: The time at which this environment was created.
description String: A brief description of this environment.
displayName String: Display name of this environment for the UI.
name String: Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
postStartupScript String: Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"
vmImage Property Map: Use a Compute Engine VM image to start the notebook instance.

Supporting Types

ContainerImageResponse

Repository string: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
Tag string: The tag of the container image. If not specified, this defaults to the latest tag.

Repository string: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
Tag string: The tag of the container image. If not specified, this defaults to the latest tag.

repository String: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag String: The tag of the container image. If not specified, this defaults to the latest tag.

repository string: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag string: The tag of the container image. If not specified, this defaults to the latest tag.

repository str: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag str: The tag of the container image. If not specified, this defaults to the latest tag.

repository String: The path to the container image repository. For example: gcr.io/{project_id}/{image_name}
tag String: The tag of the container image. If not specified, this defaults to the latest tag.

VmImageResponse

ImageFamily string: Use this VM image family to find the image; the newest image in this family will be used.
ImageName string: Use VM image name to find the image.
Project string: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

ImageFamily string: Use this VM image family to find the image; the newest image in this family will be used.
ImageName string: Use VM image name to find the image.
Project string: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

imageFamily String: Use this VM image family to find the image; the newest image in this family will be used.
imageName String: Use VM image name to find the image.
project String: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

imageFamily string: Use this VM image family to find the image; the newest image in this family will be used.
imageName string: Use VM image name to find the image.
project string: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

image_family str: Use this VM image family to find the image; the newest image in this family will be used.
image_name str: Use VM image name to find the image.
project str: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

imageFamily String: Use this VM image family to find the image; the newest image in this family will be used.
imageName String: Use VM image name to find the image.
project String: The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0