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

ibm.getSchematicsInventory

Explore with Pulumi AI

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

Retrieve information about the Schematics inventory. For more information, about Schematics action inventories, see Creating resource inventories for Schematics actions.

Example Usage

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

const schematicsInventory = ibm.getSchematicsInventory({
    inventoryId: "inventory_id",
});
Copy
import pulumi
import pulumi_ibm as ibm

schematics_inventory = ibm.get_schematics_inventory(inventory_id="inventory_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.LookupSchematicsInventory(ctx, &ibm.LookupSchematicsInventoryArgs{
			InventoryId: "inventory_id",
		}, nil)
		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 schematicsInventory = Ibm.GetSchematicsInventory.Invoke(new()
    {
        InventoryId = "inventory_id",
    });

});
Copy
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.GetSchematicsInventoryArgs;
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 schematicsInventory = IbmFunctions.getSchematicsInventory(GetSchematicsInventoryArgs.builder()
            .inventoryId("inventory_id")
            .build());

    }
}
Copy
variables:
  schematicsInventory:
    fn::invoke:
      function: ibm:getSchematicsInventory
      arguments:
        inventoryId: inventory_id
Copy

Using getSchematicsInventory

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 getSchematicsInventory(args: GetSchematicsInventoryArgs, opts?: InvokeOptions): Promise<GetSchematicsInventoryResult>
function getSchematicsInventoryOutput(args: GetSchematicsInventoryOutputArgs, opts?: InvokeOptions): Output<GetSchematicsInventoryResult>
Copy
def get_schematics_inventory(inventory_id: Optional[str] = None,
                             location: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSchematicsInventoryResult
def get_schematics_inventory_output(inventory_id: Optional[pulumi.Input[str]] = None,
                             location: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsInventoryResult]
Copy
func LookupSchematicsInventory(ctx *Context, args *LookupSchematicsInventoryArgs, opts ...InvokeOption) (*LookupSchematicsInventoryResult, error)
func LookupSchematicsInventoryOutput(ctx *Context, args *LookupSchematicsInventoryOutputArgs, opts ...InvokeOption) LookupSchematicsInventoryResultOutput
Copy

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

public static class GetSchematicsInventory 
{
    public static Task<GetSchematicsInventoryResult> InvokeAsync(GetSchematicsInventoryArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsInventoryResult> Invoke(GetSchematicsInventoryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSchematicsInventoryResult> getSchematicsInventory(GetSchematicsInventoryArgs args, InvokeOptions options)
public static Output<GetSchematicsInventoryResult> getSchematicsInventory(GetSchematicsInventoryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getSchematicsInventory:getSchematicsInventory
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InventoryId This property is required. string
Resource Inventory Id. Use GET /v2/inventories API to look up the Resource Inventory definition Ids in your IBM Cloud account.
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
InventoryId This property is required. string
Resource Inventory Id. Use GET /v2/inventories API to look up the Resource Inventory definition Ids in your IBM Cloud account.
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
inventoryId This property is required. String
Resource Inventory Id. Use GET /v2/inventories API to look up the Resource Inventory definition Ids in your IBM Cloud account.
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
inventoryId This property is required. string
Resource Inventory Id. Use GET /v2/inventories API to look up the Resource Inventory definition Ids in your IBM Cloud account.
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
inventory_id This property is required. str
Resource Inventory Id. Use GET /v2/inventories API to look up the Resource Inventory definition Ids in your IBM Cloud account.
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
inventoryId This property is required. String
Resource Inventory Id. Use GET /v2/inventories API to look up the Resource Inventory definition Ids in your IBM Cloud account.
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

getSchematicsInventory Result

The following output properties are available:

CreatedAt string
(String) The inventory creation time.
CreatedBy string
(String) The Email address of user who created the Inventory.
Description string
(String) The description of your inventory. The description can be up to 2048 characters long in size.
Id string
(String) The inventory ID.
InventoriesIni string
(String) Input inventory of host and host group for the playbook, in the .ini file format.
InventoryId string
Location string
Name string
(String) The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.
ResourceGroup string
(String) The resource group name for the inventory definition. By default, inventory will be created in Default Resource Group.
ResourceQueries List<string>
(List) Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.
UpdatedAt string
(String) The inventory updation time.
UpdatedBy string
(String) The Email address of user who updated the inventory.
CreatedAt string
(String) The inventory creation time.
CreatedBy string
(String) The Email address of user who created the Inventory.
Description string
(String) The description of your inventory. The description can be up to 2048 characters long in size.
Id string
(String) The inventory ID.
InventoriesIni string
(String) Input inventory of host and host group for the playbook, in the .ini file format.
InventoryId string
Location string
Name string
(String) The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.
ResourceGroup string
(String) The resource group name for the inventory definition. By default, inventory will be created in Default Resource Group.
ResourceQueries []string
(List) Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.
UpdatedAt string
(String) The inventory updation time.
UpdatedBy string
(String) The Email address of user who updated the inventory.
createdAt String
(String) The inventory creation time.
createdBy String
(String) The Email address of user who created the Inventory.
description String
(String) The description of your inventory. The description can be up to 2048 characters long in size.
id String
(String) The inventory ID.
inventoriesIni String
(String) Input inventory of host and host group for the playbook, in the .ini file format.
inventoryId String
location String
name String
(String) The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.
resourceGroup String
(String) The resource group name for the inventory definition. By default, inventory will be created in Default Resource Group.
resourceQueries List<String>
(List) Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.
updatedAt String
(String) The inventory updation time.
updatedBy String
(String) The Email address of user who updated the inventory.
createdAt string
(String) The inventory creation time.
createdBy string
(String) The Email address of user who created the Inventory.
description string
(String) The description of your inventory. The description can be up to 2048 characters long in size.
id string
(String) The inventory ID.
inventoriesIni string
(String) Input inventory of host and host group for the playbook, in the .ini file format.
inventoryId string
location string
name string
(String) The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.
resourceGroup string
(String) The resource group name for the inventory definition. By default, inventory will be created in Default Resource Group.
resourceQueries string[]
(List) Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.
updatedAt string
(String) The inventory updation time.
updatedBy string
(String) The Email address of user who updated the inventory.
created_at str
(String) The inventory creation time.
created_by str
(String) The Email address of user who created the Inventory.
description str
(String) The description of your inventory. The description can be up to 2048 characters long in size.
id str
(String) The inventory ID.
inventories_ini str
(String) Input inventory of host and host group for the playbook, in the .ini file format.
inventory_id str
location str
name str
(String) The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.
resource_group str
(String) The resource group name for the inventory definition. By default, inventory will be created in Default Resource Group.
resource_queries Sequence[str]
(List) Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.
updated_at str
(String) The inventory updation time.
updated_by str
(String) The Email address of user who updated the inventory.
createdAt String
(String) The inventory creation time.
createdBy String
(String) The Email address of user who created the Inventory.
description String
(String) The description of your inventory. The description can be up to 2048 characters long in size.
id String
(String) The inventory ID.
inventoriesIni String
(String) Input inventory of host and host group for the playbook, in the .ini file format.
inventoryId String
location String
name String
(String) The unique name of your Inventory. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores.
resourceGroup String
(String) The resource group name for the inventory definition. By default, inventory will be created in Default Resource Group.
resourceQueries List<String>
(List) Input resource queries that is used to dynamically generate the inventory of host and host group for the playbook.
updatedAt String
(String) The inventory updation time.
updatedBy String
(String) The Email address of user who updated the inventory.

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