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

ibm.getSchematicsAgentHealth

Explore with Pulumi AI

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

    Provides a read-only data source for schematics_agent_health. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

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

const schematicsAgentHealth = ibm.getSchematicsAgentHealth({
    agentId: ibm_schematics_agent_health.schematics_agent_health.agent_id,
});

    import pulumi
import pulumi_ibm as ibm

schematics_agent_health = ibm.get_schematics_agent_health(agent_id=ibm_schematics_agent_health["schematics_agent_health"]["agent_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.LookupSchematicsAgentHealth(ctx, &ibm.LookupSchematicsAgentHealthArgs{
			AgentId: ibm_schematics_agent_health.Schematics_agent_health.Agent_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 schematicsAgentHealth = Ibm.GetSchematicsAgentHealth.Invoke(new()
    {
        AgentId = ibm_schematics_agent_health.Schematics_agent_health.Agent_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.GetSchematicsAgentHealthArgs;
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 schematicsAgentHealth = IbmFunctions.getSchematicsAgentHealth(GetSchematicsAgentHealthArgs.builder()
            .agentId(ibm_schematics_agent_health.schematics_agent_health().agent_id())
            .build());

    }
}

    variables:
  schematicsAgentHealth:
    fn::invoke:
      function: ibm:getSchematicsAgentHealth
      arguments:
        agentId: ${ibm_schematics_agent_health.schematics_agent_health.agent_id}

    Using getSchematicsAgentHealth

    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 getSchematicsAgentHealth(args: GetSchematicsAgentHealthArgs, opts?: InvokeOptions): Promise<GetSchematicsAgentHealthResult>
function getSchematicsAgentHealthOutput(args: GetSchematicsAgentHealthOutputArgs, opts?: InvokeOptions): Output<GetSchematicsAgentHealthResult>
    def get_schematics_agent_health(agent_id: Optional[str] = None,
                                id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetSchematicsAgentHealthResult
def get_schematics_agent_health_output(agent_id: Optional[pulumi.Input[str]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsAgentHealthResult]
    func LookupSchematicsAgentHealth(ctx *Context, args *LookupSchematicsAgentHealthArgs, opts ...InvokeOption) (*LookupSchematicsAgentHealthResult, error)
func LookupSchematicsAgentHealthOutput(ctx *Context, args *LookupSchematicsAgentHealthOutputArgs, opts ...InvokeOption) LookupSchematicsAgentHealthResultOutput

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

    public static class GetSchematicsAgentHealth 
{
    public static Task<GetSchematicsAgentHealthResult> InvokeAsync(GetSchematicsAgentHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsAgentHealthResult> Invoke(GetSchematicsAgentHealthInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchematicsAgentHealthResult> getSchematicsAgentHealth(GetSchematicsAgentHealthArgs args, InvokeOptions options)
public static Output<GetSchematicsAgentHealthResult> getSchematicsAgentHealth(GetSchematicsAgentHealthArgs args, InvokeOptions options)

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

    The following arguments are supported:

    AgentId string
    Agent ID to get the details of agent.
    Id string
    The unique identifier of the schematics_agent_health.
    AgentId string
    Agent ID to get the details of agent.
    Id string
    The unique identifier of the schematics_agent_health.
    agentId String
    Agent ID to get the details of agent.
    id String
    The unique identifier of the schematics_agent_health.
    agentId string
    Agent ID to get the details of agent.
    id string
    The unique identifier of the schematics_agent_health.
    agent_id str
    Agent ID to get the details of agent.
    id str
    The unique identifier of the schematics_agent_health.
    agentId String
    Agent ID to get the details of agent.
    id String
    The unique identifier of the schematics_agent_health.

    getSchematicsAgentHealth Result

    The following output properties are available:

    AgentId string
    AgentVersion string
    (String) Agent version.
    Id string
    The unique identifier of the schematics_agent_health.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full health-check job logs.
    StatusCode string
    (String) Final result of the health-check job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    StatusMessage string
    (String) The outcome of the health-check job, in a formatted log string.
    UpdatedAt string
    (String) The agent health check job updation time.
    UpdatedBy string
    (String) Email address of user who ran the agent health check job.
    AgentId string
    AgentVersion string
    (String) Agent version.
    Id string
    The unique identifier of the schematics_agent_health.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full health-check job logs.
    StatusCode string
    (String) Final result of the health-check job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    StatusMessage string
    (String) The outcome of the health-check job, in a formatted log string.
    UpdatedAt string
    (String) The agent health check job updation time.
    UpdatedBy string
    (String) Email address of user who ran the agent health check job.
    agentId String
    agentVersion String
    (String) Agent version.
    id String
    The unique identifier of the schematics_agent_health.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full health-check job logs.
    statusCode String
    (String) Final result of the health-check job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    statusMessage String
    (String) The outcome of the health-check job, in a formatted log string.
    updatedAt String
    (String) The agent health check job updation time.
    updatedBy String
    (String) Email address of user who ran the agent health check job.
    agentId string
    agentVersion string
    (String) Agent version.
    id string
    The unique identifier of the schematics_agent_health.
    jobId string
    (String) Job Id.
    logUrl string
    (String) URL to the full health-check job logs.
    statusCode string
    (String) Final result of the health-check job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    statusMessage string
    (String) The outcome of the health-check job, in a formatted log string.
    updatedAt string
    (String) The agent health check job updation time.
    updatedBy string
    (String) Email address of user who ran the agent health check job.
    agent_id str
    agent_version str
    (String) Agent version.
    id str
    The unique identifier of the schematics_agent_health.
    job_id str
    (String) Job Id.
    log_url str
    (String) URL to the full health-check job logs.
    status_code str
    (String) Final result of the health-check job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    status_message str
    (String) The outcome of the health-check job, in a formatted log string.
    updated_at str
    (String) The agent health check job updation time.
    updated_by str
    (String) Email address of user who ran the agent health check job.
    agentId String
    agentVersion String
    (String) Agent version.
    id String
    The unique identifier of the schematics_agent_health.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full health-check job logs.
    statusCode String
    (String) Final result of the health-check job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    statusMessage String
    (String) The outcome of the health-check job, in a formatted log string.
    updatedAt String
    (String) The agent health check job updation time.
    updatedBy String
    (String) Email address of user who ran the agent health check job.

    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