Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SchematicsAgentPrs
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SchematicsAgentPrs

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides a resource for schematics_agent_prs. This allows schematics_agent_prs to be created, updated and deleted.

Example Usage

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

const schematicsAgentPrsInstance = new ibm.SchematicsAgentPrs("schematicsAgentPrsInstance", {agentId: "agent_id"});
Copy
import pulumi
import pulumi_ibm as ibm

schematics_agent_prs_instance = ibm.SchematicsAgentPrs("schematicsAgentPrsInstance", agent_id="agent_id")
Copy
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.NewSchematicsAgentPrs(ctx, "schematicsAgentPrsInstance", &ibm.SchematicsAgentPrsArgs{
			AgentId: pulumi.String("agent_id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var schematicsAgentPrsInstance = new Ibm.SchematicsAgentPrs("schematicsAgentPrsInstance", new()
    {
        AgentId = "agent_id",
    });

});
Copy
package generated_program;

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

    }
}
Copy
resources:
  schematicsAgentPrsInstance:
    type: ibm:SchematicsAgentPrs
    properties:
      agentId: agent_id
Copy

Create SchematicsAgentPrs Resource

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

Constructor syntax

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

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

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SchematicsAgentPrsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SchematicsAgentPrsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SchematicsAgentPrsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SchematicsAgentPrsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SchematicsAgentPrsArgs
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 schematicsAgentPrsResource = new Ibm.SchematicsAgentPrs("schematicsAgentPrsResource", new()
{
    AgentId = "string",
    Force = false,
    SchematicsAgentPrsId = "string",
});
Copy
example, err := ibm.NewSchematicsAgentPrs(ctx, "schematicsAgentPrsResource", &ibm.SchematicsAgentPrsArgs{
AgentId: pulumi.String("string"),
Force: pulumi.Bool(false),
SchematicsAgentPrsId: pulumi.String("string"),
})
Copy
var schematicsAgentPrsResource = new SchematicsAgentPrs("schematicsAgentPrsResource", SchematicsAgentPrsArgs.builder()
    .agentId("string")
    .force(false)
    .schematicsAgentPrsId("string")
    .build());
Copy
schematics_agent_prs_resource = ibm.SchematicsAgentPrs("schematicsAgentPrsResource",
    agent_id="string",
    force=False,
    schematics_agent_prs_id="string")
Copy
const schematicsAgentPrsResource = new ibm.SchematicsAgentPrs("schematicsAgentPrsResource", {
    agentId: "string",
    force: false,
    schematicsAgentPrsId: "string",
});
Copy
type: ibm:SchematicsAgentPrs
properties:
    agentId: string
    force: false
    schematicsAgentPrsId: string
Copy

SchematicsAgentPrs 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 SchematicsAgentPrs resource accepts the following input properties:

AgentId This property is required. string
Agent ID to get the details of agent.
Force bool
Equivalent to -force options in the command line, default is false.
SchematicsAgentPrsId string
The unique identifier of the schematics_agent_prs.
AgentId This property is required. string
Agent ID to get the details of agent.
Force bool
Equivalent to -force options in the command line, default is false.
SchematicsAgentPrsId string
The unique identifier of the schematics_agent_prs.
agentId This property is required. String
Agent ID to get the details of agent.
force Boolean
Equivalent to -force options in the command line, default is false.
schematicsAgentPrsId String
The unique identifier of the schematics_agent_prs.
agentId This property is required. string
Agent ID to get the details of agent.
force boolean
Equivalent to -force options in the command line, default is false.
schematicsAgentPrsId string
The unique identifier of the schematics_agent_prs.
agent_id This property is required. str
Agent ID to get the details of agent.
force bool
Equivalent to -force options in the command line, default is false.
schematics_agent_prs_id str
The unique identifier of the schematics_agent_prs.
agentId This property is required. String
Agent ID to get the details of agent.
force Boolean
Equivalent to -force options in the command line, default is false.
schematicsAgentPrsId String
The unique identifier of the schematics_agent_prs.

Outputs

All input properties are implicitly available as output properties. Additionally, the SchematicsAgentPrs 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 pre-requisite scanner job logs.
StatusCode string
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
StatusMessage string
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
UpdatedAt string
(String) The agent prs job updation time.
UpdatedBy string
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
StatusCode string
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
StatusMessage string
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
UpdatedAt string
(String) The agent prs job updation time.
UpdatedBy string
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
statusCode String
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
statusMessage String
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
updatedAt String
(String) The agent prs job updation time.
updatedBy String
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
statusCode string
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
statusMessage string
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
updatedAt string
(String) The agent prs job updation time.
updatedBy string
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
status_code str
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
status_message str
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
updated_at str
(String) The agent prs job updation time.
updated_by str
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
statusCode String
(String) Final result of the pre-requisite scanner job.

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

Look up Existing SchematicsAgentPrs Resource

Get an existing SchematicsAgentPrs 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?: SchematicsAgentPrsState, opts?: CustomResourceOptions): SchematicsAgentPrs
@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_prs_id: Optional[str] = None,
        status_code: Optional[str] = None,
        status_message: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None) -> SchematicsAgentPrs
func GetSchematicsAgentPrs(ctx *Context, name string, id IDInput, state *SchematicsAgentPrsState, opts ...ResourceOption) (*SchematicsAgentPrs, error)
public static SchematicsAgentPrs Get(string name, Input<string> id, SchematicsAgentPrsState? state, CustomResourceOptions? opts = null)
public static SchematicsAgentPrs get(String name, Output<String> id, SchematicsAgentPrsState state, CustomResourceOptions options)
resources:  _:    type: ibm:SchematicsAgentPrs    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 pre-requisite scanner job logs.
SchematicsAgentPrsId string
The unique identifier of the schematics_agent_prs.
StatusCode string
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
StatusMessage string
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
UpdatedAt string
(String) The agent prs job updation time.
UpdatedBy string
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
SchematicsAgentPrsId string
The unique identifier of the schematics_agent_prs.
StatusCode string
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
StatusMessage string
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
UpdatedAt string
(String) The agent prs job updation time.
UpdatedBy string
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
schematicsAgentPrsId String
The unique identifier of the schematics_agent_prs.
statusCode String
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
statusMessage String
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
updatedAt String
(String) The agent prs job updation time.
updatedBy String
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
schematicsAgentPrsId string
The unique identifier of the schematics_agent_prs.
statusCode string
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
statusMessage string
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
updatedAt string
(String) The agent prs job updation time.
updatedBy string
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
schematics_agent_prs_id str
The unique identifier of the schematics_agent_prs.
status_code str
(String) Final result of the pre-requisite scanner job.

  • Constraints: Allowable values are: pending, in-progress, success, failed.
status_message str
(String) The outcome of the pre-requisite scanner job, in a formatted log string.
updated_at str
(String) The agent prs job updation time.
updated_by str
(String) Email address of user who ran the agent prs 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 pre-requisite scanner job logs.
schematicsAgentPrsId String
The unique identifier of the schematics_agent_prs.
statusCode String
(String) Final result of the pre-requisite scanner job.

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

Import

You can import the ibm_schematics_agent_prs 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/schematicsAgentPrs:SchematicsAgentPrs schematics_agent_prs <agent_id>/<agent_id>
Copy

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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm