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

ibm.SchematicsAgentHealth

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 resource for schematics_agent_health. This allows schematics_agent_health to be created, updated and deleted.

    Example Usage

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

const schematicsAgentHealthInstance = new ibm.SchematicsAgentHealth("schematicsAgentHealthInstance", {agentId: "agent_id"});

    import pulumi
import pulumi_ibm as ibm

schematics_agent_health_instance = ibm.SchematicsAgentHealth("schematicsAgentHealthInstance", agent_id="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.NewSchematicsAgentHealth(ctx, "schematicsAgentHealthInstance", &ibm.SchematicsAgentHealthArgs{
			AgentId: pulumi.String("agent_id"),
		})
		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 schematicsAgentHealthInstance = new Ibm.SchematicsAgentHealth("schematicsAgentHealthInstance", new()
    {
        AgentId = "agent_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SchematicsAgentHealth;
import com.pulumi.ibm.SchematicsAgentHealthArgs;
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) {
        var schematicsAgentHealthInstance = new SchematicsAgentHealth("schematicsAgentHealthInstance", SchematicsAgentHealthArgs.builder()
            .agentId("agent_id")
            .build());

    }
}

    resources:
  schematicsAgentHealthInstance:
    type: ibm:SchematicsAgentHealth
    properties:
      agentId: agent_id

    Create SchematicsAgentHealth Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SchematicsAgentHealth(name: string, args: SchematicsAgentHealthArgs, opts?: CustomResourceOptions);
    @overload
def SchematicsAgentHealth(resource_name: str,
                          args: SchematicsAgentHealthArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def SchematicsAgentHealth(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          agent_id: Optional[str] = None,
                          force: Optional[bool] = None,
                          schematics_agent_health_id: Optional[str] = None)
    func NewSchematicsAgentHealth(ctx *Context, name string, args SchematicsAgentHealthArgs, opts ...ResourceOption) (*SchematicsAgentHealth, error)
    public SchematicsAgentHealth(string name, SchematicsAgentHealthArgs args, CustomResourceOptions? opts = null)
    public SchematicsAgentHealth(String name, SchematicsAgentHealthArgs args)
public SchematicsAgentHealth(String name, SchematicsAgentHealthArgs args, CustomResourceOptions options)

    type: ibm:SchematicsAgentHealth
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SchematicsAgentHealthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SchematicsAgentHealthArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SchematicsAgentHealthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchematicsAgentHealthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchematicsAgentHealthArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var schematicsAgentHealthResource = new Ibm.SchematicsAgentHealth("schematicsAgentHealthResource", new()
{
    AgentId = "string",
    Force = false,
    SchematicsAgentHealthId = "string",
});

    example, err := ibm.NewSchematicsAgentHealth(ctx, "schematicsAgentHealthResource", &ibm.SchematicsAgentHealthArgs{
	AgentId:                 pulumi.String("string"),
	Force:                   pulumi.Bool(false),
	SchematicsAgentHealthId: pulumi.String("string"),
})

    var schematicsAgentHealthResource = new SchematicsAgentHealth("schematicsAgentHealthResource", SchematicsAgentHealthArgs.builder()
    .agentId("string")
    .force(false)
    .schematicsAgentHealthId("string")
    .build());

    schematics_agent_health_resource = ibm.SchematicsAgentHealth("schematicsAgentHealthResource",
    agent_id="string",
    force=False,
    schematics_agent_health_id="string")

    const schematicsAgentHealthResource = new ibm.SchematicsAgentHealth("schematicsAgentHealthResource", {
    agentId: "string",
    force: false,
    schematicsAgentHealthId: "string",
});

    type: ibm:SchematicsAgentHealth
properties:
    agentId: string
    force: false
    schematicsAgentHealthId: string

    SchematicsAgentHealth Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SchematicsAgentHealth resource accepts the following input properties:

    AgentId string
    Agent ID to get the details of agent.
    Force bool
    Equivalent to -force options in the command line, default is false.
    SchematicsAgentHealthId string
    The unique identifier of the schematics_agent_health.
    AgentId string
    Agent ID to get the details of agent.
    Force bool
    Equivalent to -force options in the command line, default is false.
    SchematicsAgentHealthId string
    The unique identifier of the schematics_agent_health.
    agentId String
    Agent ID to get the details of agent.
    force Boolean
    Equivalent to -force options in the command line, default is false.
    schematicsAgentHealthId String
    The unique identifier of the schematics_agent_health.
    agentId string
    Agent ID to get the details of agent.
    force boolean
    Equivalent to -force options in the command line, default is false.
    schematicsAgentHealthId string
    The unique identifier of the schematics_agent_health.
    agent_id str
    Agent ID to get the details of agent.
    force bool
    Equivalent to -force options in the command line, default is false.
    schematics_agent_health_id str
    The unique identifier of the schematics_agent_health.
    agentId String
    Agent ID to get the details of agent.
    force Boolean
    Equivalent to -force options in the command line, default is false.
    schematicsAgentHealthId String
    The unique identifier of the schematics_agent_health.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SchematicsAgentHealth resource produces the following output properties:

    AgentVersion string
    (String) Agent version.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    AgentVersion string
    (String) Agent version.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    agentVersion String
    (String) Agent version.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    agentVersion string
    (String) Agent version.
    id string
    The provider-assigned unique ID for this managed resource.
    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_version str
    (String) Agent version.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    agentVersion String
    (String) Agent version.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Look up Existing SchematicsAgentHealth Resource

    Get an existing SchematicsAgentHealth resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SchematicsAgentHealthState, opts?: CustomResourceOptions): SchematicsAgentHealth
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        agent_version: Optional[str] = None,
        force: Optional[bool] = None,
        job_id: Optional[str] = None,
        log_url: Optional[str] = None,
        schematics_agent_health_id: Optional[str] = None,
        status_code: Optional[str] = None,
        status_message: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None) -> SchematicsAgentHealth
    func GetSchematicsAgentHealth(ctx *Context, name string, id IDInput, state *SchematicsAgentHealthState, opts ...ResourceOption) (*SchematicsAgentHealth, error)
    public static SchematicsAgentHealth Get(string name, Input<string> id, SchematicsAgentHealthState? state, CustomResourceOptions? opts = null)
    public static SchematicsAgentHealth get(String name, Output<String> id, SchematicsAgentHealthState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SchematicsAgentHealth    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentId string
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    Force bool
    Equivalent to -force options in the command line, default is false.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full health-check job logs.
    SchematicsAgentHealthId string
    The unique identifier of the schematics_agent_health.
    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
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    Force bool
    Equivalent to -force options in the command line, default is false.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full health-check job logs.
    SchematicsAgentHealthId string
    The unique identifier of the schematics_agent_health.
    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
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    force Boolean
    Equivalent to -force options in the command line, default is false.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full health-check job logs.
    schematicsAgentHealthId String
    The unique identifier of the schematics_agent_health.
    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
    Agent ID to get the details of agent.
    agentVersion string
    (String) Agent version.
    force boolean
    Equivalent to -force options in the command line, default is false.
    jobId string
    (String) Job Id.
    logUrl string
    (String) URL to the full health-check job logs.
    schematicsAgentHealthId string
    The unique identifier of the schematics_agent_health.
    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 ID to get the details of agent.
    agent_version str
    (String) Agent version.
    force bool
    Equivalent to -force options in the command line, default is false.
    job_id str
    (String) Job Id.
    log_url str
    (String) URL to the full health-check job logs.
    schematics_agent_health_id str
    The unique identifier of the schematics_agent_health.
    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
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    force Boolean
    Equivalent to -force options in the command line, default is false.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full health-check job logs.
    schematicsAgentHealthId String
    The unique identifier of the schematics_agent_health.
    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.

    Import

    You can import the ibm_schematics_agent_health resource by using agent_id.

    The agent_id property can be formed from agent_id, and agent_id in the following format:

    <agent_id>/<agent_id>

    • agent_id: A string. Agent ID to get the details of agent.

    • agent_id: A string. Agent ID to get the details of agent.

    Syntax

    $ pulumi import ibm:index/schematicsAgentHealth:SchematicsAgentHealth schematics_agent_health <agent_id>/<agent_id>

    To learn more about importing existing cloud resources, see Importing resources.

    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