ibm.getSchematicsState

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 schematicsState = ibm.getSchematicsState({
    templateId: "template_id",
    workspaceId: "workspace_id",
});

import pulumi
import pulumi_ibm as ibm

schematics_state = ibm.get_schematics_state(template_id="template_id",
    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.GetSchematicsState(ctx, &ibm.GetSchematicsStateArgs{
			TemplateId:  "template_id",
			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 schematicsState = Ibm.GetSchematicsState.Invoke(new()
    {
        TemplateId = "template_id",
        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.GetSchematicsStateArgs;
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 schematicsState = IbmFunctions.getSchematicsState(GetSchematicsStateArgs.builder()
            .templateId("template_id")
            .workspaceId("workspace_id")
            .build());

    }
}

variables:
  schematicsState:
    fn::invoke:
      function: ibm:getSchematicsState
      arguments:
        templateId: template_id
        workspaceId: workspace_id

Using getSchematicsState

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 getSchematicsState(args: GetSchematicsStateArgs, opts?: InvokeOptions): Promise<GetSchematicsStateResult>
function getSchematicsStateOutput(args: GetSchematicsStateOutputArgs, opts?: InvokeOptions): Output<GetSchematicsStateResult>

def get_schematics_state(id: Optional[str] = None,
                         location: Optional[str] = None,
                         template_id: Optional[str] = None,
                         workspace_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSchematicsStateResult
def get_schematics_state_output(id: Optional[pulumi.Input[str]] = None,
                         location: Optional[pulumi.Input[str]] = None,
                         template_id: Optional[pulumi.Input[str]] = None,
                         workspace_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsStateResult]

func GetSchematicsState(ctx *Context, args *GetSchematicsStateArgs, opts ...InvokeOption) (*GetSchematicsStateResult, error)
func GetSchematicsStateOutput(ctx *Context, args *GetSchematicsStateOutputArgs, opts ...InvokeOption) GetSchematicsStateResultOutput

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

public static class GetSchematicsState 
{
    public static Task<GetSchematicsStateResult> InvokeAsync(GetSchematicsStateArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsStateResult> Invoke(GetSchematicsStateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSchematicsStateResult> getSchematicsState(GetSchematicsStateArgs args, InvokeOptions options)
public static Output<GetSchematicsStateResult> getSchematicsState(GetSchematicsStateArgs args, InvokeOptions options)

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

The following arguments are supported:

TemplateId string

WorkspaceId string

Id string

(String) The unique ID of the Schematics state.

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.