Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSchematicsOutput
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getSchematicsOutput

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Example Usage

    The following example retrieves information about the my-workspace-id workspace.

    Using getSchematicsOutput

    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 getSchematicsOutput(args: GetSchematicsOutputArgs, opts?: InvokeOptions): Promise<GetSchematicsOutputResult>
function getSchematicsOutputOutput(args: GetSchematicsOutputOutputArgs, opts?: InvokeOptions): Output<GetSchematicsOutputResult>
    def get_schematics_output(id: Optional[str] = None,
                          location: Optional[str] = None,
                          output_json: Optional[str] = None,
                          template_id: Optional[str] = None,
                          workspace_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSchematicsOutputResult
def get_schematics_output_output(id: Optional[pulumi.Input[str]] = None,
                          location: Optional[pulumi.Input[str]] = None,
                          output_json: Optional[pulumi.Input[str]] = None,
                          template_id: Optional[pulumi.Input[str]] = None,
                          workspace_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsOutputResult]
    func GetSchematicsOutput(ctx *Context, args *GetSchematicsOutputArgs, opts ...InvokeOption) (*GetSchematicsOutputResult, error)
func GetSchematicsOutputOutput(ctx *Context, args *GetSchematicsOutputOutputArgs, opts ...InvokeOption) GetSchematicsOutputResultOutput

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

    public static class GetSchematicsOutput 
{
    public static Task<GetSchematicsOutputResult> InvokeAsync(GetSchematicsOutputArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsOutputResult> Invoke(GetSchematicsOutputInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchematicsOutputResult> getSchematicsOutput(GetSchematicsOutputArgs args, InvokeOptions options)
public static Output<GetSchematicsOutputResult> getSchematicsOutput(GetSchematicsOutputArgs args, InvokeOptions options)

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

    The following arguments are supported:

    TemplateId string
    The ID of the template
    WorkspaceId string
    The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the GET /workspaces API.
    Id string
    (String) The unique identifier of the Schematics output.
    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
    OutputJson string
    The json output in string
    TemplateId string
    The ID of the template
    WorkspaceId string
    The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the GET /workspaces API.
    Id string
    (String) The unique identifier of the Schematics output.
    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
    OutputJson string
    The json output in string
    templateId String
    The ID of the template
    workspaceId String
    The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the GET /workspaces API.
    id String
    (String) The unique identifier of the Schematics output.
    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
    outputJson String
    The json output in string
    templateId string
    The ID of the template
    workspaceId string
    The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the GET /workspaces API.
    id string
    (String) The unique identifier of the Schematics output.
    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
    outputJson string
    The json output in string
    template_id str
    The ID of the template
    workspace_id str
    The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the GET /workspaces API.
    id str
    (String) The unique identifier of the Schematics output.
    location str
    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
    output_json str
    The json output in string
    templateId String
    The ID of the template
    workspaceId String
    The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the GET /workspaces API.
    id String
    (String) The unique identifier of the Schematics output.
    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
    outputJson String
    The json output in string

    getSchematicsOutput Result

    The following output properties are available:

    Id string
    (String) The unique identifier of the Schematics output.
    OutputValues Dictionary<string, string>
    (Map) Output values.
    ResourceControllerUrl string
    (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about this Workspace
    TemplateId string
    WorkspaceId string
    Location string
    OutputJson string
    Id string
    (String) The unique identifier of the Schematics output.
    OutputValues map[string]string
    (Map) Output values.
    ResourceControllerUrl string
    (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about this Workspace
    TemplateId string
    WorkspaceId string
    Location string
    OutputJson string
    id String
    (String) The unique identifier of the Schematics output.
    outputValues Map<String,String>
    (Map) Output values.
    resourceControllerUrl String
    (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about this Workspace
    templateId String
    workspaceId String
    location String
    outputJson String
    id string
    (String) The unique identifier of the Schematics output.
    outputValues {[key: string]: string}
    (Map) Output values.
    resourceControllerUrl string
    (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about this Workspace
    templateId string
    workspaceId string
    location string
    outputJson string
    id str
    (String) The unique identifier of the Schematics output.
    output_values Mapping[str, str]
    (Map) Output values.
    resource_controller_url str
    (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about this Workspace
    template_id str
    workspace_id str
    location str
    output_json str
    id String
    (String) The unique identifier of the Schematics output.
    outputValues Map<String>
    (Map) Output values.
    resourceControllerUrl String
    (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about this Workspace
    templateId String
    workspaceId String
    location String
    outputJson String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm