1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSchematicsPolicy
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getSchematicsPolicy

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

    Provides a read-only data source for schematics_policy. 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 schematicsPolicy = ibm.getSchematicsPolicy({
        policyId: "policy_id",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    schematics_policy = ibm.get_schematics_policy(policy_id="policy_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.LookupSchematicsPolicy(ctx, &ibm.LookupSchematicsPolicyArgs{
    			PolicyId: "policy_id",
    		}, 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 schematicsPolicy = Ibm.GetSchematicsPolicy.Invoke(new()
        {
            PolicyId = "policy_id",
        });
    
    });
    
    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.GetSchematicsPolicyArgs;
    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 schematicsPolicy = IbmFunctions.getSchematicsPolicy(GetSchematicsPolicyArgs.builder()
                .policyId("policy_id")
                .build());
    
        }
    }
    
    variables:
      schematicsPolicy:
        fn::invoke:
          function: ibm:getSchematicsPolicy
          arguments:
            policyId: policy_id
    

    Using getSchematicsPolicy

    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 getSchematicsPolicy(args: GetSchematicsPolicyArgs, opts?: InvokeOptions): Promise<GetSchematicsPolicyResult>
    function getSchematicsPolicyOutput(args: GetSchematicsPolicyOutputArgs, opts?: InvokeOptions): Output<GetSchematicsPolicyResult>
    def get_schematics_policy(policy_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetSchematicsPolicyResult
    def get_schematics_policy_output(policy_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsPolicyResult]
    func LookupSchematicsPolicy(ctx *Context, args *LookupSchematicsPolicyArgs, opts ...InvokeOption) (*LookupSchematicsPolicyResult, error)
    func LookupSchematicsPolicyOutput(ctx *Context, args *LookupSchematicsPolicyOutputArgs, opts ...InvokeOption) LookupSchematicsPolicyResultOutput

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

    public static class GetSchematicsPolicy 
    {
        public static Task<GetSchematicsPolicyResult> InvokeAsync(GetSchematicsPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetSchematicsPolicyResult> Invoke(GetSchematicsPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSchematicsPolicyResult> getSchematicsPolicy(GetSchematicsPolicyArgs args, InvokeOptions options)
    public static Output<GetSchematicsPolicyResult> getSchematicsPolicy(GetSchematicsPolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getSchematicsPolicy:getSchematicsPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PolicyId string
    ID to get the details of policy.
    PolicyId string
    ID to get the details of policy.
    policyId String
    ID to get the details of policy.
    policyId string
    ID to get the details of policy.
    policy_id str
    ID to get the details of policy.
    policyId String
    ID to get the details of policy.

    getSchematicsPolicy Result

    The following output properties are available:

    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) Schematics resource Id.
    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    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) Name of Schematics customization policy.
    Parameters List<GetSchematicsPolicyParameter>
    (List) The parameter to tune the Schematics policy. Nested scheme for parameter:
    PolicyId string
    ResourceGroup string
    (String) The resource group name for the policy. By default, Policy will be created in default Resource Group.
    ScopedResources List<GetSchematicsPolicyScopedResource>
    (List) List of scoped Schematics resources targeted by the policy. Nested scheme for scoped_resources:
    States List<GetSchematicsPolicyState>
    (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) The tag based selector.
    Targets List<GetSchematicsPolicyTarget>
    (List) The objects for the Schematics policy. Nested scheme for target:
    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) Schematics resource Id.
    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    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) Name of Schematics customization policy.
    Parameters []GetSchematicsPolicyParameter
    (List) The parameter to tune the Schematics policy. Nested scheme for parameter:
    PolicyId string
    ResourceGroup string
    (String) The resource group name for the policy. By default, Policy will be created in default Resource Group.
    ScopedResources []GetSchematicsPolicyScopedResource
    (List) List of scoped Schematics resources targeted by the policy. Nested scheme for scoped_resources:
    States []GetSchematicsPolicyState
    (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) The tag based selector.
    Targets []GetSchematicsPolicyTarget
    (List) The objects for the Schematics policy. Nested scheme for target:
    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) Schematics resource Id.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    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) Name of Schematics customization policy.
    parameters List<GetSchematicsPolicyParameter>
    (List) The parameter to tune the Schematics policy. Nested scheme for parameter:
    policyId String
    resourceGroup String
    (String) The resource group name for the policy. By default, Policy will be created in default Resource Group.
    scopedResources List<GetSchematicsPolicyScopedResource>
    (List) List of scoped Schematics resources targeted by the policy. Nested scheme for scoped_resources:
    states List<GetSchematicsPolicyState>
    (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) The tag based selector.
    targets List<GetSchematicsPolicyTarget>
    (List) The objects for the Schematics policy. Nested scheme for target:
    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) Schematics resource Id.
    kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    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) Name of Schematics customization policy.
    parameters GetSchematicsPolicyParameter[]
    (List) The parameter to tune the Schematics policy. Nested scheme for parameter:
    policyId string
    resourceGroup string
    (String) The resource group name for the policy. By default, Policy will be created in default Resource Group.
    scopedResources GetSchematicsPolicyScopedResource[]
    (List) List of scoped Schematics resources targeted by the policy. Nested scheme for scoped_resources:
    states GetSchematicsPolicyState[]
    (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) The tag based selector.
    targets GetSchematicsPolicyTarget[]
    (List) The objects for the Schematics policy. Nested scheme for target:
    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) Schematics resource Id.
    kind str
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    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) Name of Schematics customization policy.
    parameters Sequence[GetSchematicsPolicyParameter]
    (List) The parameter to tune the Schematics policy. Nested scheme for parameter:
    policy_id str
    resource_group str
    (String) The resource group name for the policy. By default, Policy will be created in default Resource Group.
    scoped_resources Sequence[GetSchematicsPolicyScopedResource]
    (List) List of scoped Schematics resources targeted by the policy. Nested scheme for scoped_resources:
    states Sequence[GetSchematicsPolicyState]
    (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) The tag based selector.
    targets Sequence[GetSchematicsPolicyTarget]
    (List) The objects for the Schematics policy. Nested scheme for target:
    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) Schematics resource Id.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    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) Name of Schematics customization policy.
    parameters List<Property Map>
    (List) The parameter to tune the Schematics policy. Nested scheme for parameter:
    policyId String
    resourceGroup String
    (String) The resource group name for the policy. By default, Policy will be created in default Resource Group.
    scopedResources List<Property Map>
    (List) List of scoped Schematics resources targeted by the policy. Nested scheme for scoped_resources:
    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) The tag based selector.
    targets List<Property Map>
    (List) The objects for the Schematics policy. Nested scheme for target:
    updatedAt String
    (String) The policy updation time.

    Supporting Types

    GetSchematicsPolicyParameter

    AgentAssignmentPolicyParameters List<GetSchematicsPolicyParameterAgentAssignmentPolicyParameter>
    (List) Parameters for the agent_assignment_policy. Nested scheme for agent_assignment_policy_parameter:
    AgentAssignmentPolicyParameters []GetSchematicsPolicyParameterAgentAssignmentPolicyParameter
    (List) Parameters for the agent_assignment_policy. Nested scheme for agent_assignment_policy_parameter:
    agentAssignmentPolicyParameters List<GetSchematicsPolicyParameterAgentAssignmentPolicyParameter>
    (List) Parameters for the agent_assignment_policy. Nested scheme for agent_assignment_policy_parameter:
    agentAssignmentPolicyParameters GetSchematicsPolicyParameterAgentAssignmentPolicyParameter[]
    (List) Parameters for the agent_assignment_policy. Nested scheme for agent_assignment_policy_parameter:
    agent_assignment_policy_parameters Sequence[GetSchematicsPolicyParameterAgentAssignmentPolicyParameter]
    (List) Parameters for the agent_assignment_policy. Nested scheme for agent_assignment_policy_parameter:
    agentAssignmentPolicyParameters List<Property Map>
    (List) Parameters for the agent_assignment_policy. Nested scheme for agent_assignment_policy_parameter:

    GetSchematicsPolicyParameterAgentAssignmentPolicyParameter

    SelectorIds List<string>
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    SelectorKind string
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    SelectorScopes List<GetSchematicsPolicyParameterAgentAssignmentPolicyParameterSelectorScope>
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    SelectorIds []string
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    SelectorKind string
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    SelectorScopes []GetSchematicsPolicyParameterAgentAssignmentPolicyParameterSelectorScope
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selectorIds List<String>
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selectorKind String
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selectorScopes List<GetSchematicsPolicyParameterAgentAssignmentPolicyParameterSelectorScope>
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selectorIds string[]
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selectorKind string
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selectorScopes GetSchematicsPolicyParameterAgentAssignmentPolicyParameterSelectorScope[]
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selector_ids Sequence[str]
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selector_kind str
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selector_scopes Sequence[GetSchematicsPolicyParameterAgentAssignmentPolicyParameterSelectorScope]
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selectorIds List<String>
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selectorKind String
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selectorScopes List<Property Map>
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:

    GetSchematicsPolicyParameterAgentAssignmentPolicyParameterSelectorScope

    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    Locations List<string>
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    ResourceGroups List<string>
    (List) The resource group based selector.
    Tags List<string>
    (List) The tag based selector.
    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    Locations []string
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    ResourceGroups []string
    (List) The resource group based selector.
    Tags []string
    (List) The tag based selector.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations List<String>
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resourceGroups List<String>
    (List) The resource group based selector.
    tags List<String>
    (List) The tag based selector.
    kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations string[]
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resourceGroups string[]
    (List) The resource group based selector.
    tags string[]
    (List) The tag based selector.
    kind str
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations Sequence[str]
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resource_groups Sequence[str]
    (List) The resource group based selector.
    tags Sequence[str]
    (List) The tag based selector.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations List<String>
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resourceGroups List<String>
    (List) The resource group based selector.
    tags List<String>
    (List) The tag based selector.

    GetSchematicsPolicyScopedResource

    Id string
    (String) Schematics resource Id.
    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    Id string
    (String) Schematics resource Id.
    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    id String
    (String) Schematics resource Id.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    id string
    (String) Schematics resource Id.
    kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    id str
    (String) Schematics resource Id.
    kind str
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    id String
    (String) Schematics resource Id.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.

    GetSchematicsPolicyState

    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.

    GetSchematicsPolicyTarget

    SelectorIds List<string>
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    SelectorKind string
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    SelectorScopes List<GetSchematicsPolicyTargetSelectorScope>
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    SelectorIds []string
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    SelectorKind string
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    SelectorScopes []GetSchematicsPolicyTargetSelectorScope
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selectorIds List<String>
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selectorKind String
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selectorScopes List<GetSchematicsPolicyTargetSelectorScope>
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selectorIds string[]
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selectorKind string
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selectorScopes GetSchematicsPolicyTargetSelectorScope[]
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selector_ids Sequence[str]
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selector_kind str
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selector_scopes Sequence[GetSchematicsPolicyTargetSelectorScope]
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:
    selectorIds List<String>
    (List) Static selectors of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy.
    selectorKind String
    (String) Types of schematics object selector.

    • Constraints: Allowable values are: ids, scoped.
    selectorScopes List<Property Map>
    (List) Selectors to dynamically list of schematics object ids (agent, workspace, action or blueprint) for the Schematics policy. Nested scheme for selector_scope:

    GetSchematicsPolicyTargetSelectorScope

    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    Locations List<string>
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    ResourceGroups List<string>
    (List) The resource group based selector.
    Tags List<string>
    (List) The tag based selector.
    Kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    Locations []string
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    ResourceGroups []string
    (List) The resource group based selector.
    Tags []string
    (List) The tag based selector.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations List<String>
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resourceGroups List<String>
    (List) The resource group based selector.
    tags List<String>
    (List) The tag based selector.
    kind string
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations string[]
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resourceGroups string[]
    (List) The resource group based selector.
    tags string[]
    (List) The tag based selector.
    kind str
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations Sequence[str]
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resource_groups Sequence[str]
    (List) The resource group based selector.
    tags Sequence[str]
    (List) The tag based selector.
    kind String
    (String) Name of the Schematics automation resource.

    • Constraints: Allowable values are: workspace, action, system, environment, blueprint.
    locations List<String>
    (List) The location based selector.

    • Constraints: Allowable list items are: us-south, us-east, eu-gb, eu-de.
    resourceGroups List<String>
    (List) The resource group based selector.
    tags List<String>
    (List) The tag based selector.

    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.77.1 published on Monday, Apr 14, 2025 by ibm-cloud