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

ibm.getSchematicsPolicies

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_policies. 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 schematicsPolicies = ibm.getSchematicsPolicies({});

    import pulumi
import pulumi_ibm as ibm

schematics_policies = ibm.get_schematics_policies()

    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.GetSchematicsPolicies(ctx, &ibm.GetSchematicsPoliciesArgs{}, 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 schematicsPolicies = Ibm.GetSchematicsPolicies.Invoke();

});

    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.GetSchematicsPoliciesArgs;
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 schematicsPolicies = IbmFunctions.getSchematicsPolicies();

    }
}

    variables:
  schematicsPolicies:
    fn::invoke:
      function: ibm:getSchematicsPolicies
      arguments: {}

    Using getSchematicsPolicies

    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 getSchematicsPolicies(args: GetSchematicsPoliciesArgs, opts?: InvokeOptions): Promise<GetSchematicsPoliciesResult>
function getSchematicsPoliciesOutput(args: GetSchematicsPoliciesOutputArgs, opts?: InvokeOptions): Output<GetSchematicsPoliciesResult>
    def get_schematics_policies(id: Optional[str] = None,
                            policy_kind: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSchematicsPoliciesResult
def get_schematics_policies_output(id: Optional[pulumi.Input[str]] = None,
                            policy_kind: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsPoliciesResult]
    func GetSchematicsPolicies(ctx *Context, args *GetSchematicsPoliciesArgs, opts ...InvokeOption) (*GetSchematicsPoliciesResult, error)
func GetSchematicsPoliciesOutput(ctx *Context, args *GetSchematicsPoliciesOutputArgs, opts ...InvokeOption) GetSchematicsPoliciesResultOutput

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

    public static class GetSchematicsPolicies 
{
    public static Task<GetSchematicsPoliciesResult> InvokeAsync(GetSchematicsPoliciesArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsPoliciesResult> Invoke(GetSchematicsPoliciesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchematicsPoliciesResult> getSchematicsPolicies(GetSchematicsPoliciesArgs args, InvokeOptions options)
public static Output<GetSchematicsPoliciesResult> getSchematicsPolicies(GetSchematicsPoliciesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Id string
    (String) The system generated Policy Id.
    PolicyKind string
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    Id string
    (String) The system generated Policy Id.
    PolicyKind string
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id String
    (String) The system generated Policy Id.
    policyKind String
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id string
    (String) The system generated Policy Id.
    policyKind string
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id str
    (String) The system generated Policy Id.
    policy_kind str
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id String
    (String) The system generated Policy Id.
    policyKind String
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.

    getSchematicsPolicies Result

    The following output properties are available:

    Id string
    (String) The system generated Policy Id.
    Limit double
    (Integer) The number of policy records returned.
    Offset double
    (Integer) The skipped number of policy records.
    Policies List<GetSchematicsPoliciesPolicy>
    (List) The list of Schematics policies. Nested scheme for policies:
    TotalCount double
    (Integer) The total number of policy records.
    PolicyKind string
    (String) Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    Id string
    (String) The system generated Policy Id.
    Limit float64
    (Integer) The number of policy records returned.
    Offset float64
    (Integer) The skipped number of policy records.
    Policies []GetSchematicsPoliciesPolicy
    (List) The list of Schematics policies. Nested scheme for policies:
    TotalCount float64
    (Integer) The total number of policy records.
    PolicyKind string
    (String) Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id String
    (String) The system generated Policy Id.
    limit Double
    (Integer) The number of policy records returned.
    offset Double
    (Integer) The skipped number of policy records.
    policies List<GetSchematicsPoliciesPolicy>
    (List) The list of Schematics policies. Nested scheme for policies:
    totalCount Double
    (Integer) The total number of policy records.
    policyKind String
    (String) Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id string
    (String) The system generated Policy Id.
    limit number
    (Integer) The number of policy records returned.
    offset number
    (Integer) The skipped number of policy records.
    policies GetSchematicsPoliciesPolicy[]
    (List) The list of Schematics policies. Nested scheme for policies:
    totalCount number
    (Integer) The total number of policy records.
    policyKind string
    (String) Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id str
    (String) The system generated Policy Id.
    limit float
    (Integer) The number of policy records returned.
    offset float
    (Integer) The skipped number of policy records.
    policies Sequence[GetSchematicsPoliciesPolicy]
    (List) The list of Schematics policies. Nested scheme for policies:
    total_count float
    (Integer) The total number of policy records.
    policy_kind str
    (String) Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    id String
    (String) The system generated Policy Id.
    limit Number
    (Integer) The number of policy records returned.
    offset Number
    (Integer) The skipped number of policy records.
    policies List<Property Map>
    (List) The list of Schematics policies. Nested scheme for policies:
    totalCount Number
    (Integer) The total number of policy records.
    policyKind String
    (String) Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.

    Supporting Types

    GetSchematicsPoliciesPolicy

    Account string
    (String) The Account id.
    CreatedAt string
    (String) The policy creation time.
    CreatedBy string
    (String) The user who created the Policy.
    Crn string
    (String) The policy CRN.
    Description string
    (String) The description of Schematics customization policy.
    Id string
    (String) The system generated Policy Id.
    Location string
    (String) List of locations 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.
    Name string
    (String) The name of Schematics customization policy.
    PolicyKind string
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    ResourceGroup string
    (String) Resource-group name for the Policy. By default, Policy will be created in Default Resource Group.
    States List<GetSchematicsPoliciesPolicyState>
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    Tags List<string>
    (List) Tags for the Schematics customization policy.
    UpdatedAt string
    (String) The policy updation time.
    Account string
    (String) The Account id.
    CreatedAt string
    (String) The policy creation time.
    CreatedBy string
    (String) The user who created the Policy.
    Crn string
    (String) The policy CRN.
    Description string
    (String) The description of Schematics customization policy.
    Id string
    (String) The system generated Policy Id.
    Location string
    (String) List of locations 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.
    Name string
    (String) The name of Schematics customization policy.
    PolicyKind string
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    ResourceGroup string
    (String) Resource-group name for the Policy. By default, Policy will be created in Default Resource Group.
    States []GetSchematicsPoliciesPolicyState
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    Tags []string
    (List) Tags for the Schematics customization policy.
    UpdatedAt string
    (String) The policy updation time.
    account String
    (String) The Account id.
    createdAt String
    (String) The policy creation time.
    createdBy String
    (String) The user who created the Policy.
    crn String
    (String) The policy CRN.
    description String
    (String) The description of Schematics customization policy.
    id String
    (String) The system generated Policy Id.
    location String
    (String) List of locations 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.
    name String
    (String) The name of Schematics customization policy.
    policyKind String
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    resourceGroup String
    (String) Resource-group name for the Policy. By default, Policy will be created in Default Resource Group.
    states List<GetSchematicsPoliciesPolicyState>
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    tags List<String>
    (List) Tags for the Schematics customization policy.
    updatedAt String
    (String) The policy updation time.
    account string
    (String) The Account id.
    createdAt string
    (String) The policy creation time.
    createdBy string
    (String) The user who created the Policy.
    crn string
    (String) The policy CRN.
    description string
    (String) The description of Schematics customization policy.
    id string
    (String) The system generated Policy Id.
    location string
    (String) List of locations 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.
    name string
    (String) The name of Schematics customization policy.
    policyKind string
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    resourceGroup string
    (String) Resource-group name for the Policy. By default, Policy will be created in Default Resource Group.
    states GetSchematicsPoliciesPolicyState[]
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    tags string[]
    (List) Tags for the Schematics customization policy.
    updatedAt string
    (String) The policy updation time.
    account str
    (String) The Account id.
    created_at str
    (String) The policy creation time.
    created_by str
    (String) The user who created the Policy.
    crn str
    (String) The policy CRN.
    description str
    (String) The description of Schematics customization policy.
    id str
    (String) The system generated Policy Id.
    location str
    (String) List of locations 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.
    name str
    (String) The name of Schematics customization policy.
    policy_kind str
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    resource_group str
    (String) Resource-group name for the Policy. By default, Policy will be created in Default Resource Group.
    states Sequence[GetSchematicsPoliciesPolicyState]
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    tags Sequence[str]
    (List) Tags for the Schematics customization policy.
    updated_at str
    (String) The policy updation time.
    account String
    (String) The Account id.
    createdAt String
    (String) The policy creation time.
    createdBy String
    (String) The user who created the Policy.
    crn String
    (String) The policy CRN.
    description String
    (String) The description of Schematics customization policy.
    id String
    (String) The system generated Policy Id.
    location String
    (String) List of locations 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.
    name String
    (String) The name of Schematics customization policy.
    policyKind String
    Policy kind or categories for managing and deriving policy decision * agent_assignment_policy Agent assignment policy for job execution.

    • Constraints: Allowable values are: agent_assignment_policy.
    resourceGroup String
    (String) Resource-group name for the Policy. By default, Policy will be created in Default Resource Group.
    states List<Property Map>
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    tags List<String>
    (List) Tags for the Schematics customization policy.
    updatedAt String
    (String) The policy updation time.

    GetSchematicsPoliciesPolicyState

    SetAt string
    (String) When the User who set the state of the Object.
    SetBy string
    (String) Name of the User who set the state of the Object.
    State string
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    SetAt string
    (String) When the User who set the state of the Object.
    SetBy string
    (String) Name of the User who set the state of the Object.
    State string
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    setAt String
    (String) When the User who set the state of the Object.
    setBy String
    (String) Name of the User who set the state of the Object.
    state String
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    setAt string
    (String) When the User who set the state of the Object.
    setBy string
    (String) Name of the User who set the state of the Object.
    state string
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    set_at str
    (String) When the User who set the state of the Object.
    set_by str
    (String) Name of the User who set the state of the Object.
    state str
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.
    setAt String
    (String) When the User who set the state of the Object.
    setBy String
    (String) Name of the User who set the state of the Object.
    state String
    (String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

    • Constraints: Allowable values are: draft, live, locked, disable.

    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