ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getSchematicsWorkspace

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const schematicsWorkspace = ibm.getSchematicsWorkspace({
    workspaceId: "workspace_id",
});

import pulumi
import pulumi_ibm as ibm

schematics_workspace = ibm.get_schematics_workspace(workspace_id="workspace_id")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupSchematicsWorkspace(ctx, &ibm.LookupSchematicsWorkspaceArgs{
			WorkspaceId: "workspace_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var schematicsWorkspace = Ibm.GetSchematicsWorkspace.Invoke(new()
    {
        WorkspaceId = "workspace_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSchematicsWorkspaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var schematicsWorkspace = IbmFunctions.getSchematicsWorkspace(GetSchematicsWorkspaceArgs.builder()
            .workspaceId("workspace_id")
            .build());

    }
}

variables:
  schematicsWorkspace:
    fn::invoke:
      function: ibm:getSchematicsWorkspace
      arguments:
        workspaceId: workspace_id

Using getSchematicsWorkspace

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 getSchematicsWorkspace(args: GetSchematicsWorkspaceArgs, opts?: InvokeOptions): Promise<GetSchematicsWorkspaceResult>
function getSchematicsWorkspaceOutput(args: GetSchematicsWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetSchematicsWorkspaceResult>

def get_schematics_workspace(id: Optional[str] = None,
                             location: Optional[str] = None,
                             template_git_has_uploadedgitrepotar: Optional[bool] = None,
                             template_values_metadatas: Optional[Sequence[GetSchematicsWorkspaceTemplateValuesMetadata]] = None,
                             workspace_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSchematicsWorkspaceResult
def get_schematics_workspace_output(id: Optional[pulumi.Input[str]] = None,
                             location: Optional[pulumi.Input[str]] = None,
                             template_git_has_uploadedgitrepotar: Optional[pulumi.Input[bool]] = None,
                             template_values_metadatas: Optional[pulumi.Input[Sequence[pulumi.Input[GetSchematicsWorkspaceTemplateValuesMetadataArgs]]]] = None,
                             workspace_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsWorkspaceResult]

func LookupSchematicsWorkspace(ctx *Context, args *LookupSchematicsWorkspaceArgs, opts ...InvokeOption) (*LookupSchematicsWorkspaceResult, error)
func LookupSchematicsWorkspaceOutput(ctx *Context, args *LookupSchematicsWorkspaceOutputArgs, opts ...InvokeOption) LookupSchematicsWorkspaceResultOutput

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

public static class GetSchematicsWorkspace 
{
    public static Task<GetSchematicsWorkspaceResult> InvokeAsync(GetSchematicsWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsWorkspaceResult> Invoke(GetSchematicsWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSchematicsWorkspaceResult> getSchematicsWorkspace(GetSchematicsWorkspaceArgs args, InvokeOptions options)
public static Output<GetSchematicsWorkspaceResult> getSchematicsWorkspace(GetSchematicsWorkspaceArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getSchematicsWorkspace:getSchematicsWorkspace
  arguments:
    # arguments dictionary

The following arguments are supported:

WorkspaceId string

The ID of the workspace. To find the workspace ID, use the GET /v1/workspaces API.

Id string

Location string

Location supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

TemplateGitHasUploadedgitrepotar bool

(Boolean) Has uploaded Git repository tar.

TemplateValuesMetadatas List<GetSchematicsWorkspaceTemplateValuesMetadata>

(List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

WorkspaceId string

The ID of the workspace. To find the workspace ID, use the GET /v1/workspaces API.

Id string

Location string

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

TemplateGitHasUploadedgitrepotar bool

(Boolean) Has uploaded Git repository tar.

TemplateValuesMetadatas []GetSchematicsWorkspaceTemplateValuesMetadata

(List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

workspaceId String

The ID of the workspace. To find the workspace ID, use the GET /v1/workspaces API.

id String

location String

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

templateGitHasUploadedgitrepotar Boolean

(Boolean) Has uploaded Git repository tar.

templateValuesMetadatas List<GetSchematicsWorkspaceTemplateValuesMetadata>

(List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

workspaceId string

The ID of the workspace. To find the workspace ID, use the GET /v1/workspaces API.

id string

location string

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

templateGitHasUploadedgitrepotar boolean

(Boolean) Has uploaded Git repository tar.

templateValuesMetadatas GetSchematicsWorkspaceTemplateValuesMetadata[]

(List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

workspace_id str

The ID of the workspace. To find the workspace ID, use the GET /v1/workspaces API.

id str

location str

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

template_git_has_uploadedgitrepotar bool

(Boolean) Has uploaded Git repository tar.

template_values_metadatas Sequence[GetSchematicsWorkspaceTemplateValuesMetadata]

(List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

workspaceId String

The ID of the workspace. To find the workspace ID, use the GET /v1/workspaces API.

id String

location String

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

templateGitHasUploadedgitrepotar Boolean

(Boolean) Has uploaded Git repository tar.

templateValuesMetadatas List<Property Map>

(List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

getSchematicsWorkspace Result

The following output properties are available:

AppliedShareddataIds List<string>: (List) List of applied shared dataset ID.
CatalogReves List<GetSchematicsWorkspaceCatalogRef>: (List) Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. Nested scheme for catalog_ref:
CreatedAt string: (String) The timestamp when the workspace was created.
CreatedBy string: (String) The user ID that created the workspace.
Crn string: (String) The workspace CRN.
Description string: (String) The description of your input variable.
Frozen bool: (Boolean) If set to true, the workspace is frozen and changes to the workspace are disabled.
FrozenAt string: (String) The timestamp when the workspace was frozen.
FrozenBy string: (String) The user ID that froze the workspace.
Id string
IsFrozen bool: Deprecated: Deprecated
IsLocked bool: Deprecated: Deprecated
LastHealthCheckAt string: (String) The timestamp when the last health check was performed by Schematics.
Location string
Locked bool: (Boolean) If set to true, the workspace is locked and disabled for changes.
LockedBy string: (String) The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
LockedTime string: (String) The timestamp when the workspace was locked.
Name string: (String) The name of the variable.
ResourceControllerUrl string
ResourceGroup string: (String) The resource group the workspace was provisioned in.
RuntimeDatas List<GetSchematicsWorkspaceRuntimeData>: (List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
SharedDatas List<GetSchematicsWorkspaceSharedData>
Status string
StatusCode string: (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
StatusMsg string: (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
Tags List<string>: (List) A list of tags that are associated with the workspace.
TemplateEnvSettings List<GetSchematicsWorkspaceTemplateEnvSetting>: (List) List of environment values. Nested scheme for env_values:
TemplateGitBranch string: (String) The repository branch.
TemplateGitFolder string
TemplateGitFullUrl string: (String) Full repository URL.
TemplateGitHasUploadedgitrepotar bool: (Boolean) Has uploaded Git repository tar.
TemplateGitRelease string: (String) The repository release.
TemplateGitRepoShaValue string: (String) The repository SHA value.
TemplateGitRepoUrl string: (String) The repository URL.
TemplateGitUrl string: (String) The source URL.
TemplateInitStateFile string
TemplateInputs List<GetSchematicsWorkspaceTemplateInput>: (List) Information about the input variables that your template uses. Nested scheme for variablestore:
TemplateRef string: (String) Workspace template reference.
TemplateType string
TemplateUninstallScriptName string: (String) Uninstall script name.
TemplateValues string
UpdatedAt string: (String) The timestamp when the workspace was last updated.
UpdatedBy string: (String) The user ID that updated the workspace.
WorkspaceId string
TemplateValuesMetadatas List<GetSchematicsWorkspaceTemplateValuesMetadata>: (List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

AppliedShareddataIds []string: (List) List of applied shared dataset ID.
CatalogReves []GetSchematicsWorkspaceCatalogRef: (List) Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. Nested scheme for catalog_ref:
CreatedAt string: (String) The timestamp when the workspace was created.
CreatedBy string: (String) The user ID that created the workspace.
Crn string: (String) The workspace CRN.
Description string: (String) The description of your input variable.
Frozen bool: (Boolean) If set to true, the workspace is frozen and changes to the workspace are disabled.
FrozenAt string: (String) The timestamp when the workspace was frozen.
FrozenBy string: (String) The user ID that froze the workspace.
Id string
IsFrozen bool: Deprecated: Deprecated
IsLocked bool: Deprecated: Deprecated
LastHealthCheckAt string: (String) The timestamp when the last health check was performed by Schematics.
Location string
Locked bool: (Boolean) If set to true, the workspace is locked and disabled for changes.
LockedBy string: (String) The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
LockedTime string: (String) The timestamp when the workspace was locked.
Name string: (String) The name of the variable.
ResourceControllerUrl string
ResourceGroup string: (String) The resource group the workspace was provisioned in.
RuntimeDatas []GetSchematicsWorkspaceRuntimeData: (List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
SharedDatas []GetSchematicsWorkspaceSharedData
Status string
StatusCode string: (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
StatusMsg string: (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
Tags []string: (List) A list of tags that are associated with the workspace.
TemplateEnvSettings []GetSchematicsWorkspaceTemplateEnvSetting: (List) List of environment values. Nested scheme for env_values:
TemplateGitBranch string: (String) The repository branch.
TemplateGitFolder string
TemplateGitFullUrl string: (String) Full repository URL.
TemplateGitHasUploadedgitrepotar bool: (Boolean) Has uploaded Git repository tar.
TemplateGitRelease string: (String) The repository release.
TemplateGitRepoShaValue string: (String) The repository SHA value.
TemplateGitRepoUrl string: (String) The repository URL.
TemplateGitUrl string: (String) The source URL.
TemplateInitStateFile string
TemplateInputs []GetSchematicsWorkspaceTemplateInput: (List) Information about the input variables that your template uses. Nested scheme for variablestore:
TemplateRef string: (String) Workspace template reference.
TemplateType string
TemplateUninstallScriptName string: (String) Uninstall script name.
TemplateValues string
UpdatedAt string: (String) The timestamp when the workspace was last updated.
UpdatedBy string: (String) The user ID that updated the workspace.
WorkspaceId string
TemplateValuesMetadatas []GetSchematicsWorkspaceTemplateValuesMetadata: (List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

appliedShareddataIds List<String>: (List) List of applied shared dataset ID.
catalogReves List<GetSchematicsWorkspaceCatalogRef>: (List) Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. Nested scheme for catalog_ref:
createdAt String: (String) The timestamp when the workspace was created.
createdBy String: (String) The user ID that created the workspace.
crn String: (String) The workspace CRN.
description String: (String) The description of your input variable.
frozen Boolean: (Boolean) If set to true, the workspace is frozen and changes to the workspace are disabled.
frozenAt String: (String) The timestamp when the workspace was frozen.
frozenBy String: (String) The user ID that froze the workspace.
id String
isFrozen Boolean: Deprecated: Deprecated
isLocked Boolean: Deprecated: Deprecated
lastHealthCheckAt String: (String) The timestamp when the last health check was performed by Schematics.
location String
locked Boolean: (Boolean) If set to true, the workspace is locked and disabled for changes.
lockedBy String: (String) The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
lockedTime String: (String) The timestamp when the workspace was locked.
name String: (String) The name of the variable.
resourceControllerUrl String
resourceGroup String: (String) The resource group the workspace was provisioned in.
runtimeDatas List<GetSchematicsWorkspaceRuntimeData>: (List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
sharedDatas List<GetSchematicsWorkspaceSharedData>
status String
statusCode String: (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
statusMsg String: (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
tags List<String>: (List) A list of tags that are associated with the workspace.
templateEnvSettings List<GetSchematicsWorkspaceTemplateEnvSetting>: (List) List of environment values. Nested scheme for env_values:
templateGitBranch String: (String) The repository branch.
templateGitFolder String
templateGitFullUrl String: (String) Full repository URL.
templateGitHasUploadedgitrepotar Boolean: (Boolean) Has uploaded Git repository tar.
templateGitRelease String: (String) The repository release.
templateGitRepoShaValue String: (String) The repository SHA value.
templateGitRepoUrl String: (String) The repository URL.
templateGitUrl String: (String) The source URL.
templateInitStateFile String
templateInputs List<GetSchematicsWorkspaceTemplateInput>: (List) Information about the input variables that your template uses. Nested scheme for variablestore:
templateRef String: (String) Workspace template reference.
templateType String
templateUninstallScriptName String: (String) Uninstall script name.
templateValues String
updatedAt String: (String) The timestamp when the workspace was last updated.
updatedBy String: (String) The user ID that updated the workspace.
workspaceId String
templateValuesMetadatas List<GetSchematicsWorkspaceTemplateValuesMetadata>: (List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

appliedShareddataIds string[]: (List) List of applied shared dataset ID.
catalogReves GetSchematicsWorkspaceCatalogRef[]: (List) Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. Nested scheme for catalog_ref:
createdAt string: (String) The timestamp when the workspace was created.
createdBy string: (String) The user ID that created the workspace.
crn string: (String) The workspace CRN.
description string: (String) The description of your input variable.
frozen boolean: (Boolean) If set to true, the workspace is frozen and changes to the workspace are disabled.
frozenAt string: (String) The timestamp when the workspace was frozen.
frozenBy string: (String) The user ID that froze the workspace.
id string
isFrozen boolean: Deprecated: Deprecated
isLocked boolean: Deprecated: Deprecated
lastHealthCheckAt string: (String) The timestamp when the last health check was performed by Schematics.
location string
locked boolean: (Boolean) If set to true, the workspace is locked and disabled for changes.
lockedBy string: (String) The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
lockedTime string: (String) The timestamp when the workspace was locked.
name string: (String) The name of the variable.
resourceControllerUrl string
resourceGroup string: (String) The resource group the workspace was provisioned in.
runtimeDatas GetSchematicsWorkspaceRuntimeData[]: (List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
sharedDatas GetSchematicsWorkspaceSharedData[]
status string
statusCode string: (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
statusMsg string: (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
tags string[]: (List) A list of tags that are associated with the workspace.
templateEnvSettings GetSchematicsWorkspaceTemplateEnvSetting[]: (List) List of environment values. Nested scheme for env_values:
templateGitBranch string: (String) The repository branch.
templateGitFolder string
templateGitFullUrl string: (String) Full repository URL.
templateGitHasUploadedgitrepotar boolean: (Boolean) Has uploaded Git repository tar.
templateGitRelease string: (String) The repository release.
templateGitRepoShaValue string: (String) The repository SHA value.
templateGitRepoUrl string: (String) The repository URL.
templateGitUrl string: (String) The source URL.
templateInitStateFile string
templateInputs GetSchematicsWorkspaceTemplateInput[]: (List) Information about the input variables that your template uses. Nested scheme for variablestore:
templateRef string: (String) Workspace template reference.
templateType string
templateUninstallScriptName string: (String) Uninstall script name.
templateValues string
updatedAt string: (String) The timestamp when the workspace was last updated.
updatedBy string: (String) The user ID that updated the workspace.
workspaceId string
templateValuesMetadatas GetSchematicsWorkspaceTemplateValuesMetadata[]: (List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

applied_shareddata_ids Sequence[str]: (List) List of applied shared dataset ID.
catalog_reves Sequence[GetSchematicsWorkspaceCatalogRef]: (List) Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. Nested scheme for catalog_ref:
created_at str: (String) The timestamp when the workspace was created.
created_by str: (String) The user ID that created the workspace.
crn str: (String) The workspace CRN.
description str: (String) The description of your input variable.
frozen bool: (Boolean) If set to true, the workspace is frozen and changes to the workspace are disabled.
frozen_at str: (String) The timestamp when the workspace was frozen.
frozen_by str: (String) The user ID that froze the workspace.
id str
is_frozen bool: Deprecated: Deprecated
is_locked bool: Deprecated: Deprecated
last_health_check_at str: (String) The timestamp when the last health check was performed by Schematics.
location str
locked bool: (Boolean) If set to true, the workspace is locked and disabled for changes.
locked_by str: (String) The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
locked_time str: (String) The timestamp when the workspace was locked.
name str: (String) The name of the variable.
resource_controller_url str
resource_group str: (String) The resource group the workspace was provisioned in.
runtime_datas Sequence[GetSchematicsWorkspaceRuntimeData]: (List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
shared_datas Sequence[GetSchematicsWorkspaceSharedData]
status str
status_code str: (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
status_msg str: (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
tags Sequence[str]: (List) A list of tags that are associated with the workspace.
template_env_settings Sequence[GetSchematicsWorkspaceTemplateEnvSetting]: (List) List of environment values. Nested scheme for env_values:
template_git_branch str: (String) The repository branch.
template_git_folder str
template_git_full_url str: (String) Full repository URL.
template_git_has_uploadedgitrepotar bool: (Boolean) Has uploaded Git repository tar.
template_git_release str: (String) The repository release.
template_git_repo_sha_value str: (String) The repository SHA value.
template_git_repo_url str: (String) The repository URL.
template_git_url str: (String) The source URL.
template_init_state_file str
template_inputs Sequence[GetSchematicsWorkspaceTemplateInput]: (List) Information about the input variables that your template uses. Nested scheme for variablestore:
template_ref str: (String) Workspace template reference.
template_type str
template_uninstall_script_name str: (String) Uninstall script name.
template_values str
updated_at str: (String) The timestamp when the workspace was last updated.
updated_by str: (String) The user ID that updated the workspace.
workspace_id str
template_values_metadatas Sequence[GetSchematicsWorkspaceTemplateValuesMetadata]: (List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

appliedShareddataIds List<String>: (List) List of applied shared dataset ID.
catalogReves List<Property Map>: (List) Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. Nested scheme for catalog_ref:
createdAt String: (String) The timestamp when the workspace was created.
createdBy String: (String) The user ID that created the workspace.
crn String: (String) The workspace CRN.
description String: (String) The description of your input variable.
frozen Boolean: (Boolean) If set to true, the workspace is frozen and changes to the workspace are disabled.
frozenAt String: (String) The timestamp when the workspace was frozen.
frozenBy String: (String) The user ID that froze the workspace.
id String
isFrozen Boolean: Deprecated: Deprecated
isLocked Boolean: Deprecated: Deprecated
lastHealthCheckAt String: (String) The timestamp when the last health check was performed by Schematics.
location String
locked Boolean: (Boolean) If set to true, the workspace is locked and disabled for changes.
lockedBy String: (String) The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
lockedTime String: (String) The timestamp when the workspace was locked.
name String: (String) The name of the variable.
resourceControllerUrl String
resourceGroup String: (String) The resource group the workspace was provisioned in.
runtimeDatas List<Property Map>: (List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
sharedDatas List<Property Map>
status String
statusCode String: (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
statusMsg String: (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
tags List<String>: (List) A list of tags that are associated with the workspace.
templateEnvSettings List<Property Map>: (List) List of environment values. Nested scheme for env_values:
templateGitBranch String: (String) The repository branch.
templateGitFolder String
templateGitFullUrl String: (String) Full repository URL.
templateGitHasUploadedgitrepotar Boolean: (Boolean) Has uploaded Git repository tar.
templateGitRelease String: (String) The repository release.
templateGitRepoShaValue String: (String) The repository SHA value.
templateGitRepoUrl String: (String) The repository URL.
templateGitUrl String: (String) The source URL.
templateInitStateFile String
templateInputs List<Property Map>: (List) Information about the input variables that your template uses. Nested scheme for variablestore:
templateRef String: (String) Workspace template reference.
templateType String
templateUninstallScriptName String: (String) Uninstall script name.
templateValues String
updatedAt String: (String) The timestamp when the workspace was last updated.
updatedBy String: (String) The user ID that updated the workspace.
workspaceId String
templateValuesMetadatas List<Property Map>: (List) A list of input variables that are associated with the workspace. Nested scheme for values_metadata:

Supporting Types

GetSchematicsWorkspaceCatalogRef

DryRun bool: (Boolean) Dry run.
ItemIconUrl string: (String) The URL to the icon of the software template in the IBM Cloud catalog.
ItemId string: (String) The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
ItemName string: (String) The name of the software that you chose to install from the IBM Cloud catalog.
ItemReadmeUrl string: (String) The URL to the readme file of the software template in the IBM Cloud catalog.
ItemUrl string: (String) The URL to the software template in the IBM Cloud catalog.
LaunchUrl string: (String) The URL to the dashboard to access your software.
OfferingVersion string: (String) The version of the software template that you chose to install from the IBM Cloud catalog.
OwningAccount string: (String) Owning account ID of the catalog.
ServiceExtensions string: (String) Service extensions defined as string of json

DryRun bool: (Boolean) Dry run.
ItemIconUrl string: (String) The URL to the icon of the software template in the IBM Cloud catalog.
ItemId string: (String) The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
ItemName string: (String) The name of the software that you chose to install from the IBM Cloud catalog.
ItemReadmeUrl string: (String) The URL to the readme file of the software template in the IBM Cloud catalog.
ItemUrl string: (String) The URL to the software template in the IBM Cloud catalog.
LaunchUrl string: (String) The URL to the dashboard to access your software.
OfferingVersion string: (String) The version of the software template that you chose to install from the IBM Cloud catalog.
OwningAccount string: (String) Owning account ID of the catalog.
ServiceExtensions string: (String) Service extensions defined as string of json

dryRun Boolean: (Boolean) Dry run.
itemIconUrl String: (String) The URL to the icon of the software template in the IBM Cloud catalog.
itemId String: (String) The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
itemName String: (String) The name of the software that you chose to install from the IBM Cloud catalog.
itemReadmeUrl String: (String) The URL to the readme file of the software template in the IBM Cloud catalog.
itemUrl String: (String) The URL to the software template in the IBM Cloud catalog.
launchUrl String: (String) The URL to the dashboard to access your software.
offeringVersion String: (String) The version of the software template that you chose to install from the IBM Cloud catalog.
owningAccount String: (String) Owning account ID of the catalog.
serviceExtensions String: (String) Service extensions defined as string of json

dryRun boolean: (Boolean) Dry run.
itemIconUrl string: (String) The URL to the icon of the software template in the IBM Cloud catalog.
itemId string: (String) The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
itemName string: (String) The name of the software that you chose to install from the IBM Cloud catalog.
itemReadmeUrl string: (String) The URL to the readme file of the software template in the IBM Cloud catalog.
itemUrl string: (String) The URL to the software template in the IBM Cloud catalog.
launchUrl string: (String) The URL to the dashboard to access your software.
offeringVersion string: (String) The version of the software template that you chose to install from the IBM Cloud catalog.
owningAccount string: (String) Owning account ID of the catalog.
serviceExtensions string: (String) Service extensions defined as string of json

dry_run bool: (Boolean) Dry run.
item_icon_url str: (String) The URL to the icon of the software template in the IBM Cloud catalog.
item_id str: (String) The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
item_name str: (String) The name of the software that you chose to install from the IBM Cloud catalog.
item_readme_url str: (String) The URL to the readme file of the software template in the IBM Cloud catalog.
item_url str: (String) The URL to the software template in the IBM Cloud catalog.
launch_url str: (String) The URL to the dashboard to access your software.
offering_version str: (String) The version of the software template that you chose to install from the IBM Cloud catalog.
owning_account str: (String) Owning account ID of the catalog.
service_extensions str: (String) Service extensions defined as string of json

dryRun Boolean: (Boolean) Dry run.
itemIconUrl String: (String) The URL to the icon of the software template in the IBM Cloud catalog.
itemId String: (String) The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
itemName String: (String) The name of the software that you chose to install from the IBM Cloud catalog.
itemReadmeUrl String: (String) The URL to the readme file of the software template in the IBM Cloud catalog.
itemUrl String: (String) The URL to the software template in the IBM Cloud catalog.
launchUrl String: (String) The URL to the dashboard to access your software.
offeringVersion String: (String) The version of the software template that you chose to install from the IBM Cloud catalog.
owningAccount String: (String) Owning account ID of the catalog.
serviceExtensions String: (String) Service extensions defined as string of json

GetSchematicsWorkspaceRuntimeData

EngineCmd string
EngineName string
EngineVersion string: (String) The version of the provisioning engine that was used.
Id string
LogStoreUrl string: (String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
OutputValues List<ImmutableDictionary<string, string>>: (List) List of Output values.
Resources List<ImmutableDictionary<string, string>>: (List) List of resources.
StateStoreUrl string

EngineCmd string
EngineName string
EngineVersion string: (String) The version of the provisioning engine that was used.
Id string
LogStoreUrl string: (String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
OutputValues []map[string]string: (List) List of Output values.
Resources []map[string]string: (List) List of resources.
StateStoreUrl string

engineCmd String
engineName String
engineVersion String: (String) The version of the provisioning engine that was used.
id String
logStoreUrl String: (String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
outputValues List<Map<String,String>>: (List) List of Output values.
resources List<Map<String,String>>: (List) List of resources.
stateStoreUrl String

engineCmd string
engineName string
engineVersion string: (String) The version of the provisioning engine that was used.
id string
logStoreUrl string: (String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
outputValues {[key: string]: string}[]: (List) List of Output values.
resources {[key: string]: string}[]: (List) List of resources.
stateStoreUrl string

engine_cmd str
engine_name str
engine_version str: (String) The version of the provisioning engine that was used.
id str
log_store_url str: (String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
output_values Sequence[Mapping[str, str]]: (List) List of Output values.
resources Sequence[Mapping[str, str]]: (List) List of resources.
state_store_url str

engineCmd String
engineName String
engineVersion String: (String) The version of the provisioning engine that was used.
id String
logStoreUrl String: (String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
outputValues List<Map<String>>: (List) List of Output values.
resources List<Map<String>>: (List) List of resources.
stateStoreUrl String

GetSchematicsWorkspaceSharedData

ClusterId string: (String) The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
ClusterName string: (String) Target cluster name.
EntitlementKeys List<ImmutableDictionary<string, string>>: (List) The entitlement key that you want to use to install IBM Cloud entitled software.
Namespace string: (String) The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
Region string: (String) The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
ResourceGroupId string: (String) The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.

ClusterId string: (String) The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
ClusterName string: (String) Target cluster name.
EntitlementKeys []map[string]string: (List) The entitlement key that you want to use to install IBM Cloud entitled software.
Namespace string: (String) The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
Region string: (String) The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
ResourceGroupId string: (String) The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.

clusterId String: (String) The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
clusterName String: (String) Target cluster name.
entitlementKeys List<Map<String,String>>: (List) The entitlement key that you want to use to install IBM Cloud entitled software.
namespace String: (String) The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
region String: (String) The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
resourceGroupId String: (String) The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.

clusterId string: (String) The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
clusterName string: (String) Target cluster name.
entitlementKeys {[key: string]: string}[]: (List) The entitlement key that you want to use to install IBM Cloud entitled software.
namespace string: (String) The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
region string: (String) The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
resourceGroupId string: (String) The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.

cluster_id str: (String) The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
cluster_name str: (String) Target cluster name.
entitlement_keys Sequence[Mapping[str, str]]: (List) The entitlement key that you want to use to install IBM Cloud entitled software.
namespace str: (String) The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
region str: (String) The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
resource_group_id str: (String) The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.

clusterId String: (String) The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
clusterName String: (String) Target cluster name.
entitlementKeys List<Map<String>>: (List) The entitlement key that you want to use to install IBM Cloud entitled software.
namespace String: (String) The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
region String: (String) The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
resourceGroupId String: (String) The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.

GetSchematicsWorkspaceTemplateEnvSetting

Hidden bool: (Boolean) If true, the variable is not displayed on UI or Command line.
Name string: (String) The name of the variable.
Secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
Value string

Hidden bool: (Boolean) If true, the variable is not displayed on UI or Command line.
Name string: (String) The name of the variable.
Secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
Value string

hidden Boolean: (Boolean) If true, the variable is not displayed on UI or Command line.
name String: (String) The name of the variable.
secure Boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
value String

hidden boolean: (Boolean) If true, the variable is not displayed on UI or Command line.
name string: (String) The name of the variable.
secure boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
value string

hidden bool: (Boolean) If true, the variable is not displayed on UI or Command line.
name str: (String) The name of the variable.
secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
value str

hidden Boolean: (Boolean) If true, the variable is not displayed on UI or Command line.
name String: (String) The name of the variable.
secure Boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
value String

GetSchematicsWorkspaceTemplateInput

Description string: (String) The description of your input variable.
Name string: (String) The name of the variable.
Secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
Type string
Value string

Description string: (String) The description of your input variable.
Name string: (String) The name of the variable.
Secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
Type string
Value string

description String: (String) The description of your input variable.
name String: (String) The name of the variable.
secure Boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type String
value String

description string: (String) The description of your input variable.
name string: (String) The name of the variable.
secure boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type string
value string

description str: (String) The description of your input variable.
name str: (String) The name of the variable.
secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type str
value str

description String: (String) The description of your input variable.
name String: (String) The name of the variable.
secure Boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type String
value String

GetSchematicsWorkspaceTemplateValuesMetadata

Aliases List<string>

(List) The list of aliases for the variable name.

CloudDataType string

(String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.

Default string

(String) Default value for the variable only if the override value is not specified.

Description string

(String) The description of your input variable.

GroupBy string

(String) The display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable is not displayed on UI or Command line.

Immutable bool

(Boolean) Is the variable readonly ?.

LinkStatus string

(String) The status of the link.

Constraints: Allowable values are: normal, broken.

Matches string

(String) The regex for the variable value.

MaxLength double

(Integer) The maximum length of the variable value. Applicable for the string type.

MaxValue double

(Integer) The maximum value of the variable. Applicable for the integer type.

Metadatas List<GetSchematicsWorkspaceTemplateValuesMetadataMetadata>

(List) List of service data Nested scheme for metadata:

MinLength double

(Integer) The minimum length of the variable value. Applicable for the string type.

MinValue double

(Integer) The minimum value of the variable. Applicable for the integer type.

Name string

(String) The name of the variable.

Options List<string>

(List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.

Position double

(Integer) The relative position of this variable in a list.

Required bool

(Boolean) If the variable required?.

Secure bool

(Boolean) If set to true, the value of your input variable is protected and not returned in your API response.

Source string

(String) The source of this meta-data.

Type string

Type of the variable.

Value string

The value of the variable. Applicable for the integer type.

Aliases []string

(List) The list of aliases for the variable name.

CloudDataType string

(String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.

Default string

(String) Default value for the variable only if the override value is not specified.

Description string

(String) The description of your input variable.

GroupBy string

(String) The display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable is not displayed on UI or Command line.

Immutable bool

(Boolean) Is the variable readonly ?.

LinkStatus string

(String) The status of the link.

Constraints: Allowable values are: normal, broken.

Matches string

(String) The regex for the variable value.

MaxLength float64

(Integer) The maximum length of the variable value. Applicable for the string type.

MaxValue float64

(Integer) The maximum value of the variable. Applicable for the integer type.

Metadatas []GetSchematicsWorkspaceTemplateValuesMetadataMetadata

(List) List of service data Nested scheme for metadata:

MinLength float64

(Integer) The minimum length of the variable value. Applicable for the string type.

MinValue float64

(Integer) The minimum value of the variable. Applicable for the integer type.

Name string

(String) The name of the variable.

Options []string

(List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.

Position float64

(Integer) The relative position of this variable in a list.

Required bool

(Boolean) If the variable required?.

Secure bool

(Boolean) If set to true, the value of your input variable is protected and not returned in your API response.

Source string

(String) The source of this meta-data.

Type string

Type of the variable.

Value string

The value of the variable. Applicable for the integer type.

aliases List<String>

(List) The list of aliases for the variable name.

cloudDataType String

(String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.

default_ String

(String) Default value for the variable only if the override value is not specified.

description String

(String) The description of your input variable.

groupBy String

(String) The display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable is not displayed on UI or Command line.

immutable Boolean

(Boolean) Is the variable readonly ?.

linkStatus String

(String) The status of the link.

Constraints: Allowable values are: normal, broken.

matches String

(String) The regex for the variable value.

maxLength Double

(Integer) The maximum length of the variable value. Applicable for the string type.

maxValue Double

(Integer) The maximum value of the variable. Applicable for the integer type.

metadatas List<GetSchematicsWorkspaceTemplateValuesMetadataMetadata>

(List) List of service data Nested scheme for metadata:

minLength Double

(Integer) The minimum length of the variable value. Applicable for the string type.

minValue Double

(Integer) The minimum value of the variable. Applicable for the integer type.

name String

(String) The name of the variable.

options List<String>

(List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.

position Double

(Integer) The relative position of this variable in a list.

required Boolean

(Boolean) If the variable required?.

secure Boolean

(Boolean) If set to true, the value of your input variable is protected and not returned in your API response.

source String

(String) The source of this meta-data.

type String

Type of the variable.

value String

The value of the variable. Applicable for the integer type.

aliases string[]

(List) The list of aliases for the variable name.

cloudDataType string

(String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.

default string

(String) Default value for the variable only if the override value is not specified.

description string

(String) The description of your input variable.

groupBy string

(String) The display name of the group this variable belongs to.

hidden boolean

(Boolean) If true, the variable is not displayed on UI or Command line.

immutable boolean

(Boolean) Is the variable readonly ?.

linkStatus string

(String) The status of the link.

Constraints: Allowable values are: normal, broken.

matches string

(String) The regex for the variable value.

maxLength number

(Integer) The maximum length of the variable value. Applicable for the string type.

maxValue number

(Integer) The maximum value of the variable. Applicable for the integer type.

metadatas GetSchematicsWorkspaceTemplateValuesMetadataMetadata[]

(List) List of service data Nested scheme for metadata:

minLength number

(Integer) The minimum length of the variable value. Applicable for the string type.

minValue number

(Integer) The minimum value of the variable. Applicable for the integer type.

name string

(String) The name of the variable.

options string[]

(List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.

position number

(Integer) The relative position of this variable in a list.

required boolean

(Boolean) If the variable required?.

secure boolean

(Boolean) If set to true, the value of your input variable is protected and not returned in your API response.

source string

(String) The source of this meta-data.

type string

Type of the variable.

value string

The value of the variable. Applicable for the integer type.

aliases Sequence[str]

(List) The list of aliases for the variable name.

cloud_data_type str

(String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.

default str

(String) Default value for the variable only if the override value is not specified.

description str

(String) The description of your input variable.

group_by str

(String) The display name of the group this variable belongs to.

hidden bool

(Boolean) If true, the variable is not displayed on UI or Command line.

immutable bool

(Boolean) Is the variable readonly ?.

link_status str

(String) The status of the link.

Constraints: Allowable values are: normal, broken.

matches str

(String) The regex for the variable value.

max_length float

(Integer) The maximum length of the variable value. Applicable for the string type.

max_value float

(Integer) The maximum value of the variable. Applicable for the integer type.

metadatas Sequence[GetSchematicsWorkspaceTemplateValuesMetadataMetadata]

(List) List of service data Nested scheme for metadata:

min_length float

(Integer) The minimum length of the variable value. Applicable for the string type.

min_value float

(Integer) The minimum value of the variable. Applicable for the integer type.

name str

(String) The name of the variable.

options Sequence[str]

(List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.

position float

(Integer) The relative position of this variable in a list.

required bool

(Boolean) If the variable required?.

secure bool

(Boolean) If set to true, the value of your input variable is protected and not returned in your API response.

source str

(String) The source of this meta-data.

type str

Type of the variable.

value str

The value of the variable. Applicable for the integer type.

aliases List<String>

(List) The list of aliases for the variable name.

cloudDataType String

(String) Cloud data type of the variable. eg. resource_group_id, region, vpc_id.

default String

(String) Default value for the variable only if the override value is not specified.

description String

(String) The description of your input variable.

groupBy String

(String) The display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable is not displayed on UI or Command line.

immutable Boolean

(Boolean) Is the variable readonly ?.

linkStatus String

(String) The status of the link.

Constraints: Allowable values are: normal, broken.

matches String

(String) The regex for the variable value.

maxLength Number

(Integer) The maximum length of the variable value. Applicable for the string type.

maxValue Number

(Integer) The maximum value of the variable. Applicable for the integer type.

metadatas List<Property Map>

(List) List of service data Nested scheme for metadata:

minLength Number

(Integer) The minimum length of the variable value. Applicable for the string type.

minValue Number

(Integer) The minimum value of the variable. Applicable for the integer type.

name String

(String) The name of the variable.

options List<String>

(List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.

position Number

(Integer) The relative position of this variable in a list.

required Boolean

(Boolean) If the variable required?.

secure Boolean

(Boolean) If set to true, the value of your input variable is protected and not returned in your API response.

source String

(String) The source of this meta-data.

type String

Type of the variable.

value String

The value of the variable. Applicable for the integer type.

GetSchematicsWorkspaceTemplateValuesMetadataMetadata

DefaultValue string: (String) Default value for the variable only if the override value is not specified.
Description string: (String) The description of your input variable.
Hidden bool: (Boolean) If true, the variable is not displayed on UI or Command line.
Options List<string>: (List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
Required bool: (Boolean) If the variable required?.
Secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
Type string

DefaultValue string: (String) Default value for the variable only if the override value is not specified.
Description string: (String) The description of your input variable.
Hidden bool: (Boolean) If true, the variable is not displayed on UI or Command line.
Options []string: (List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
Required bool: (Boolean) If the variable required?.
Secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
Type string

defaultValue String: (String) Default value for the variable only if the override value is not specified.
description String: (String) The description of your input variable.
hidden Boolean: (Boolean) If true, the variable is not displayed on UI or Command line.
options List<String>: (List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
required Boolean: (Boolean) If the variable required?.
secure Boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type String

defaultValue string: (String) Default value for the variable only if the override value is not specified.
description string: (String) The description of your input variable.
hidden boolean: (Boolean) If true, the variable is not displayed on UI or Command line.
options string[]: (List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
required boolean: (Boolean) If the variable required?.
secure boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type string

default_value str: (String) Default value for the variable only if the override value is not specified.
description str: (String) The description of your input variable.
hidden bool: (Boolean) If true, the variable is not displayed on UI or Command line.
options Sequence[str]: (List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
required bool: (Boolean) If the variable required?.
secure bool: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type str

defaultValue String: (String) Default value for the variable only if the override value is not specified.
description String: (String) The description of your input variable.
hidden Boolean: (Boolean) If true, the variable is not displayed on UI or Command line.
options List<String>: (List) The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
required Boolean: (Boolean) If the variable required?.
secure Boolean: (Boolean) If set to true, the value of your input variable is protected and not returned in your API response.
type String

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getSchematicsWorkspace

On this page

On this page

Example Usage

Using getSchematicsWorkspace

getSchematicsWorkspace Result

Supporting Types

GetSchematicsWorkspaceCatalogRef

GetSchematicsWorkspaceRuntimeData

GetSchematicsWorkspaceSharedData

GetSchematicsWorkspaceTemplateEnvSetting

GetSchematicsWorkspaceTemplateInput

GetSchematicsWorkspaceTemplateValuesMetadata

GetSchematicsWorkspaceTemplateValuesMetadataMetadata

Package Details

On this page

On this page