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

ibm.SchematicsAgentDeploy

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_deploy. This allows schematics_agent_deploy to be created, updated and deleted.

    Example Usage

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

const schematicsAgentDeployInstance = new ibm.SchematicsAgentDeploy("schematicsAgentDeployInstance", {agentId: "agent_id"});

    import pulumi
import pulumi_ibm as ibm

schematics_agent_deploy_instance = ibm.SchematicsAgentDeploy("schematicsAgentDeployInstance", 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.NewSchematicsAgentDeploy(ctx, "schematicsAgentDeployInstance", &ibm.SchematicsAgentDeployArgs{
			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 schematicsAgentDeployInstance = new Ibm.SchematicsAgentDeploy("schematicsAgentDeployInstance", new()
    {
        AgentId = "agent_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SchematicsAgentDeploy;
import com.pulumi.ibm.SchematicsAgentDeployArgs;
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 schematicsAgentDeployInstance = new SchematicsAgentDeploy("schematicsAgentDeployInstance", SchematicsAgentDeployArgs.builder()
            .agentId("agent_id")
            .build());

    }
}

    resources:
  schematicsAgentDeployInstance:
    type: ibm:SchematicsAgentDeploy
    properties:
      agentId: agent_id

    Create SchematicsAgentDeploy Resource

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

    Constructor syntax

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

@overload
def SchematicsAgentDeploy(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          agent_id: Optional[str] = None,
                          force: Optional[bool] = None,
                          schematics_agent_deploy_id: Optional[str] = None,
                          timeouts: Optional[SchematicsAgentDeployTimeoutsArgs] = None)
    func NewSchematicsAgentDeploy(ctx *Context, name string, args SchematicsAgentDeployArgs, opts ...ResourceOption) (*SchematicsAgentDeploy, error)
    public SchematicsAgentDeploy(string name, SchematicsAgentDeployArgs args, CustomResourceOptions? opts = null)
    public SchematicsAgentDeploy(String name, SchematicsAgentDeployArgs args)
public SchematicsAgentDeploy(String name, SchematicsAgentDeployArgs args, CustomResourceOptions options)

    type: ibm:SchematicsAgentDeploy
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 SchematicsAgentDeployArgs
    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 SchematicsAgentDeployArgs
    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 SchematicsAgentDeployArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchematicsAgentDeployArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchematicsAgentDeployArgs
    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 schematicsAgentDeployResource = new Ibm.SchematicsAgentDeploy("schematicsAgentDeployResource", new()
{
    AgentId = "string",
    Force = false,
    SchematicsAgentDeployId = "string",
    Timeouts = new Ibm.Inputs.SchematicsAgentDeployTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewSchematicsAgentDeploy(ctx, "schematicsAgentDeployResource", &ibm.SchematicsAgentDeployArgs{
	AgentId:                 pulumi.String("string"),
	Force:                   pulumi.Bool(false),
	SchematicsAgentDeployId: pulumi.String("string"),
	Timeouts: &ibm.SchematicsAgentDeployTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var schematicsAgentDeployResource = new SchematicsAgentDeploy("schematicsAgentDeployResource", SchematicsAgentDeployArgs.builder()
    .agentId("string")
    .force(false)
    .schematicsAgentDeployId("string")
    .timeouts(SchematicsAgentDeployTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    schematics_agent_deploy_resource = ibm.SchematicsAgentDeploy("schematicsAgentDeployResource",
    agent_id="string",
    force=False,
    schematics_agent_deploy_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const schematicsAgentDeployResource = new ibm.SchematicsAgentDeploy("schematicsAgentDeployResource", {
    agentId: "string",
    force: false,
    schematicsAgentDeployId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:SchematicsAgentDeploy
properties:
    agentId: string
    force: false
    schematicsAgentDeployId: string
    timeouts:
        create: string
        delete: string
        update: string

    SchematicsAgentDeploy 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 SchematicsAgentDeploy 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.
    SchematicsAgentDeployId string
    The unique identifier of the schematics_agent_deploy.
    Timeouts SchematicsAgentDeployTimeouts
    AgentId string
    Agent ID to get the details of agent.
    Force bool
    Equivalent to -force options in the command line, default is false.
    SchematicsAgentDeployId string
    The unique identifier of the schematics_agent_deploy.
    Timeouts SchematicsAgentDeployTimeoutsArgs
    agentId String
    Agent ID to get the details of agent.
    force Boolean
    Equivalent to -force options in the command line, default is false.
    schematicsAgentDeployId String
    The unique identifier of the schematics_agent_deploy.
    timeouts SchematicsAgentDeployTimeouts
    agentId string
    Agent ID to get the details of agent.
    force boolean
    Equivalent to -force options in the command line, default is false.
    schematicsAgentDeployId string
    The unique identifier of the schematics_agent_deploy.
    timeouts SchematicsAgentDeployTimeouts
    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_deploy_id str
    The unique identifier of the schematics_agent_deploy.
    timeouts SchematicsAgentDeployTimeoutsArgs
    agentId String
    Agent ID to get the details of agent.
    force Boolean
    Equivalent to -force options in the command line, default is false.
    schematicsAgentDeployId String
    The unique identifier of the schematics_agent_deploy.
    timeouts Property Map

    Outputs

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

    AgentVersion string
    (String) Agent version.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsRedeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full agent deployment job logs.
    StatusCode string
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    StatusMessage string
    (String) The outcome of the agent deployment job, in a formatted log string.
    UpdatedAt string
    (String) The agent deploy job updation time.
    UpdatedBy string
    (String) Email address of user who ran the agent deploy job.
    AgentVersion string
    (String) Agent version.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsRedeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full agent deployment job logs.
    StatusCode string
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    StatusMessage string
    (String) The outcome of the agent deployment job, in a formatted log string.
    UpdatedAt string
    (String) The agent deploy job updation time.
    UpdatedBy string
    (String) Email address of user who ran the agent deploy job.
    agentVersion String
    (String) Agent version.
    id String
    The provider-assigned unique ID for this managed resource.
    isRedeployed Boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full agent deployment job logs.
    statusCode String
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    statusMessage String
    (String) The outcome of the agent deployment job, in a formatted log string.
    updatedAt String
    (String) The agent deploy job updation time.
    updatedBy String
    (String) Email address of user who ran the agent deploy job.
    agentVersion string
    (String) Agent version.
    id string
    The provider-assigned unique ID for this managed resource.
    isRedeployed boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId string
    (String) Job Id.
    logUrl string
    (String) URL to the full agent deployment job logs.
    statusCode string
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    statusMessage string
    (String) The outcome of the agent deployment job, in a formatted log string.
    updatedAt string
    (String) The agent deploy job updation time.
    updatedBy string
    (String) Email address of user who ran the agent deploy job.
    agent_version str
    (String) Agent version.
    id str
    The provider-assigned unique ID for this managed resource.
    is_redeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    job_id str
    (String) Job Id.
    log_url str
    (String) URL to the full agent deployment job logs.
    status_code str
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    status_message str
    (String) The outcome of the agent deployment job, in a formatted log string.
    updated_at str
    (String) The agent deploy job updation time.
    updated_by str
    (String) Email address of user who ran the agent deploy job.
    agentVersion String
    (String) Agent version.
    id String
    The provider-assigned unique ID for this managed resource.
    isRedeployed Boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full agent deployment job logs.
    statusCode String
    (String) Final result of the agent deployment job.

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

    Look up Existing SchematicsAgentDeploy Resource

    Get an existing SchematicsAgentDeploy 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?: SchematicsAgentDeployState, opts?: CustomResourceOptions): SchematicsAgentDeploy
    @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,
        is_redeployed: Optional[bool] = None,
        job_id: Optional[str] = None,
        log_url: Optional[str] = None,
        schematics_agent_deploy_id: Optional[str] = None,
        status_code: Optional[str] = None,
        status_message: Optional[str] = None,
        timeouts: Optional[SchematicsAgentDeployTimeoutsArgs] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None) -> SchematicsAgentDeploy
    func GetSchematicsAgentDeploy(ctx *Context, name string, id IDInput, state *SchematicsAgentDeployState, opts ...ResourceOption) (*SchematicsAgentDeploy, error)
    public static SchematicsAgentDeploy Get(string name, Input<string> id, SchematicsAgentDeployState? state, CustomResourceOptions? opts = null)
    public static SchematicsAgentDeploy get(String name, Output<String> id, SchematicsAgentDeployState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SchematicsAgentDeploy    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.
    IsRedeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full agent deployment job logs.
    SchematicsAgentDeployId string
    The unique identifier of the schematics_agent_deploy.
    StatusCode string
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    StatusMessage string
    (String) The outcome of the agent deployment job, in a formatted log string.
    Timeouts SchematicsAgentDeployTimeouts
    UpdatedAt string
    (String) The agent deploy job updation time.
    UpdatedBy string
    (String) Email address of user who ran the agent deploy 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.
    IsRedeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full agent deployment job logs.
    SchematicsAgentDeployId string
    The unique identifier of the schematics_agent_deploy.
    StatusCode string
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    StatusMessage string
    (String) The outcome of the agent deployment job, in a formatted log string.
    Timeouts SchematicsAgentDeployTimeoutsArgs
    UpdatedAt string
    (String) The agent deploy job updation time.
    UpdatedBy string
    (String) Email address of user who ran the agent deploy 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.
    isRedeployed Boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full agent deployment job logs.
    schematicsAgentDeployId String
    The unique identifier of the schematics_agent_deploy.
    statusCode String
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    statusMessage String
    (String) The outcome of the agent deployment job, in a formatted log string.
    timeouts SchematicsAgentDeployTimeouts
    updatedAt String
    (String) The agent deploy job updation time.
    updatedBy String
    (String) Email address of user who ran the agent deploy 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.
    isRedeployed boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId string
    (String) Job Id.
    logUrl string
    (String) URL to the full agent deployment job logs.
    schematicsAgentDeployId string
    The unique identifier of the schematics_agent_deploy.
    statusCode string
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    statusMessage string
    (String) The outcome of the agent deployment job, in a formatted log string.
    timeouts SchematicsAgentDeployTimeouts
    updatedAt string
    (String) The agent deploy job updation time.
    updatedBy string
    (String) Email address of user who ran the agent deploy 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.
    is_redeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    job_id str
    (String) Job Id.
    log_url str
    (String) URL to the full agent deployment job logs.
    schematics_agent_deploy_id str
    The unique identifier of the schematics_agent_deploy.
    status_code str
    (String) Final result of the agent deployment job.

    • Constraints: Allowable values are: pending, in-progress, success, failed.
    status_message str
    (String) The outcome of the agent deployment job, in a formatted log string.
    timeouts SchematicsAgentDeployTimeoutsArgs
    updated_at str
    (String) The agent deploy job updation time.
    updated_by str
    (String) Email address of user who ran the agent deploy 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.
    isRedeployed Boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full agent deployment job logs.
    schematicsAgentDeployId String
    The unique identifier of the schematics_agent_deploy.
    statusCode String
    (String) Final result of the agent deployment job.

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

    Supporting Types

    SchematicsAgentDeployTimeouts, SchematicsAgentDeployTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    You can import the ibm_schematics_agent_deploy 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/schematicsAgentDeploy:SchematicsAgentDeploy schematics_agent_deploy <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