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

ibm.OnboardingResourceBroker

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Note - Intended for internal use only. This resource is strictly experimental and subject to change without notice.

    Create, update, and delete onboarding_resource_brokers with this resource.

    Example Usage

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

const onboardingResourceBrokerInstance = new ibm.OnboardingResourceBroker("onboardingResourceBrokerInstance", {
    allowContextUpdates: false,
    authScheme: "bearer",
    authUsername: "apikey",
    brokerUrl: "https://broker-url-for-my-service.com",
    catalogType: "service",
    region: "global",
    resourceGroupCrn: "crn:v1:bluemix:public:resource-controller::a/4a5c3c51b97a446fbb1d0e1ef089823b::resource-group:4fae20bd538a4a738475350dfdc1596f",
    state: "active",
    type: "provision_through",
});

    import pulumi
import pulumi_ibm as ibm

onboarding_resource_broker_instance = ibm.OnboardingResourceBroker("onboardingResourceBrokerInstance",
    allow_context_updates=False,
    auth_scheme="bearer",
    auth_username="apikey",
    broker_url="https://broker-url-for-my-service.com",
    catalog_type="service",
    region="global",
    resource_group_crn="crn:v1:bluemix:public:resource-controller::a/4a5c3c51b97a446fbb1d0e1ef089823b::resource-group:4fae20bd538a4a738475350dfdc1596f",
    state="active",
    type="provision_through")

    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.NewOnboardingResourceBroker(ctx, "onboardingResourceBrokerInstance", &ibm.OnboardingResourceBrokerArgs{
			AllowContextUpdates: pulumi.Bool(false),
			AuthScheme:          pulumi.String("bearer"),
			AuthUsername:        pulumi.String("apikey"),
			BrokerUrl:           pulumi.String("https://broker-url-for-my-service.com"),
			CatalogType:         pulumi.String("service"),
			Region:              pulumi.String("global"),
			ResourceGroupCrn:    pulumi.String("crn:v1:bluemix:public:resource-controller::a/4a5c3c51b97a446fbb1d0e1ef089823b::resource-group:4fae20bd538a4a738475350dfdc1596f"),
			State:               pulumi.String("active"),
			Type:                pulumi.String("provision_through"),
		})
		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 onboardingResourceBrokerInstance = new Ibm.OnboardingResourceBroker("onboardingResourceBrokerInstance", new()
    {
        AllowContextUpdates = false,
        AuthScheme = "bearer",
        AuthUsername = "apikey",
        BrokerUrl = "https://broker-url-for-my-service.com",
        CatalogType = "service",
        Region = "global",
        ResourceGroupCrn = "crn:v1:bluemix:public:resource-controller::a/4a5c3c51b97a446fbb1d0e1ef089823b::resource-group:4fae20bd538a4a738475350dfdc1596f",
        State = "active",
        Type = "provision_through",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.OnboardingResourceBroker;
import com.pulumi.ibm.OnboardingResourceBrokerArgs;
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 onboardingResourceBrokerInstance = new OnboardingResourceBroker("onboardingResourceBrokerInstance", OnboardingResourceBrokerArgs.builder()
            .allowContextUpdates(false)
            .authScheme("bearer")
            .authUsername("apikey")
            .brokerUrl("https://broker-url-for-my-service.com")
            .catalogType("service")
            .region("global")
            .resourceGroupCrn("crn:v1:bluemix:public:resource-controller::a/4a5c3c51b97a446fbb1d0e1ef089823b::resource-group:4fae20bd538a4a738475350dfdc1596f")
            .state("active")
            .type("provision_through")
            .build());

    }
}

    resources:
  onboardingResourceBrokerInstance:
    type: ibm:OnboardingResourceBroker
    properties:
      allowContextUpdates: false
      authScheme: bearer
      authUsername: apikey
      brokerUrl: https://broker-url-for-my-service.com
      catalogType: service
      region: global
      resourceGroupCrn: crn:v1:bluemix:public:resource-controller::a/4a5c3c51b97a446fbb1d0e1ef089823b::resource-group:4fae20bd538a4a738475350dfdc1596f
      state: active
      type: provision_through

    Create OnboardingResourceBroker Resource

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

    Constructor syntax

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

@overload
def OnboardingResourceBroker(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             broker_url: Optional[str] = None,
                             type: Optional[str] = None,
                             auth_scheme: Optional[str] = None,
                             env: Optional[str] = None,
                             auth_username: Optional[str] = None,
                             catalog_type: Optional[str] = None,
                             allow_context_updates: Optional[bool] = None,
                             name: Optional[str] = None,
                             onboarding_resource_broker_id: Optional[str] = None,
                             region: Optional[str] = None,
                             resource_group_crn: Optional[str] = None,
                             state: Optional[str] = None,
                             auth_password: Optional[str] = None)
    func NewOnboardingResourceBroker(ctx *Context, name string, args OnboardingResourceBrokerArgs, opts ...ResourceOption) (*OnboardingResourceBroker, error)
    public OnboardingResourceBroker(string name, OnboardingResourceBrokerArgs args, CustomResourceOptions? opts = null)
    public OnboardingResourceBroker(String name, OnboardingResourceBrokerArgs args)
public OnboardingResourceBroker(String name, OnboardingResourceBrokerArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args OnboardingResourceBrokerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OnboardingResourceBrokerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OnboardingResourceBrokerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OnboardingResourceBrokerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OnboardingResourceBrokerArgs
    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 onboardingResourceBrokerResource = new Ibm.OnboardingResourceBroker("onboardingResourceBrokerResource", new()
{
    BrokerUrl = "string",
    Type = "string",
    AuthScheme = "string",
    Env = "string",
    AuthUsername = "string",
    CatalogType = "string",
    AllowContextUpdates = false,
    Name = "string",
    OnboardingResourceBrokerId = "string",
    Region = "string",
    ResourceGroupCrn = "string",
    State = "string",
    AuthPassword = "string",
});

    example, err := ibm.NewOnboardingResourceBroker(ctx, "onboardingResourceBrokerResource", &ibm.OnboardingResourceBrokerArgs{
	BrokerUrl:                  pulumi.String("string"),
	Type:                       pulumi.String("string"),
	AuthScheme:                 pulumi.String("string"),
	Env:                        pulumi.String("string"),
	AuthUsername:               pulumi.String("string"),
	CatalogType:                pulumi.String("string"),
	AllowContextUpdates:        pulumi.Bool(false),
	Name:                       pulumi.String("string"),
	OnboardingResourceBrokerId: pulumi.String("string"),
	Region:                     pulumi.String("string"),
	ResourceGroupCrn:           pulumi.String("string"),
	State:                      pulumi.String("string"),
	AuthPassword:               pulumi.String("string"),
})

    var onboardingResourceBrokerResource = new OnboardingResourceBroker("onboardingResourceBrokerResource", OnboardingResourceBrokerArgs.builder()
    .brokerUrl("string")
    .type("string")
    .authScheme("string")
    .env("string")
    .authUsername("string")
    .catalogType("string")
    .allowContextUpdates(false)
    .name("string")
    .onboardingResourceBrokerId("string")
    .region("string")
    .resourceGroupCrn("string")
    .state("string")
    .authPassword("string")
    .build());

    onboarding_resource_broker_resource = ibm.OnboardingResourceBroker("onboardingResourceBrokerResource",
    broker_url="string",
    type="string",
    auth_scheme="string",
    env="string",
    auth_username="string",
    catalog_type="string",
    allow_context_updates=False,
    name="string",
    onboarding_resource_broker_id="string",
    region="string",
    resource_group_crn="string",
    state="string",
    auth_password="string")

    const onboardingResourceBrokerResource = new ibm.OnboardingResourceBroker("onboardingResourceBrokerResource", {
    brokerUrl: "string",
    type: "string",
    authScheme: "string",
    env: "string",
    authUsername: "string",
    catalogType: "string",
    allowContextUpdates: false,
    name: "string",
    onboardingResourceBrokerId: "string",
    region: "string",
    resourceGroupCrn: "string",
    state: "string",
    authPassword: "string",
});

    type: ibm:OnboardingResourceBroker
properties:
    allowContextUpdates: false
    authPassword: string
    authScheme: string
    authUsername: string
    brokerUrl: string
    catalogType: string
    env: string
    name: string
    onboardingResourceBrokerId: string
    region: string
    resourceGroupCrn: string
    state: string
    type: string

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

    AuthScheme string
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    BrokerUrl string
    The URL associated with the broker application.
    Type string
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    AllowContextUpdates bool
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    AuthPassword string
    The authentication password to reach the broker.
    AuthUsername string
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    CatalogType string
    To enable the provisioning of your broker, set this parameter value to service.
    Env string
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    Name string
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    OnboardingResourceBrokerId string
    The unique identifier of the onboarding_resource_broker.
    Region string
    The region where the pricing plan is available.
    ResourceGroupCrn string
    The cloud resource name of the resource group.
    State string
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    AuthScheme string
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    BrokerUrl string
    The URL associated with the broker application.
    Type string
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    AllowContextUpdates bool
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    AuthPassword string
    The authentication password to reach the broker.
    AuthUsername string
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    CatalogType string
    To enable the provisioning of your broker, set this parameter value to service.
    Env string
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    Name string
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    OnboardingResourceBrokerId string
    The unique identifier of the onboarding_resource_broker.
    Region string
    The region where the pricing plan is available.
    ResourceGroupCrn string
    The cloud resource name of the resource group.
    State string
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    authScheme String
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    brokerUrl String
    The URL associated with the broker application.
    type String
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    allowContextUpdates Boolean
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    authPassword String
    The authentication password to reach the broker.
    authUsername String
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    catalogType String
    To enable the provisioning of your broker, set this parameter value to service.
    env String
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    name String
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboardingResourceBrokerId String
    The unique identifier of the onboarding_resource_broker.
    region String
    The region where the pricing plan is available.
    resourceGroupCrn String
    The cloud resource name of the resource group.
    state String
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    authScheme string
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    brokerUrl string
    The URL associated with the broker application.
    type string
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    allowContextUpdates boolean
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    authPassword string
    The authentication password to reach the broker.
    authUsername string
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    catalogType string
    To enable the provisioning of your broker, set this parameter value to service.
    env string
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    name string
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboardingResourceBrokerId string
    The unique identifier of the onboarding_resource_broker.
    region string
    The region where the pricing plan is available.
    resourceGroupCrn string
    The cloud resource name of the resource group.
    state string
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    auth_scheme str
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    broker_url str
    The URL associated with the broker application.
    type str
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    allow_context_updates bool
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    auth_password str
    The authentication password to reach the broker.
    auth_username str
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    catalog_type str
    To enable the provisioning of your broker, set this parameter value to service.
    env str
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    name str
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboarding_resource_broker_id str
    The unique identifier of the onboarding_resource_broker.
    region str
    The region where the pricing plan is available.
    resource_group_crn str
    The cloud resource name of the resource group.
    state str
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    authScheme String
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    brokerUrl String
    The URL associated with the broker application.
    type String
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    allowContextUpdates Boolean
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    authPassword String
    The authentication password to reach the broker.
    authUsername String
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    catalogType String
    To enable the provisioning of your broker, set this parameter value to service.
    env String
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    name String
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboardingResourceBrokerId String
    The unique identifier of the onboarding_resource_broker.
    region String
    The region where the pricing plan is available.
    resourceGroupCrn String
    The cloud resource name of the resource group.
    state String
    The state of the broker.

    • Constraints: Allowable values are: active, removed.

    Outputs

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

    AccountId string
    (String) The ID of the account in which you manage the broker.
    CreatedAt string
    (String) The time when the service broker was created.
    CreatedBies List<OnboardingResourceBrokerCreatedBy>
    (List) The details of the user who created this broker. Nested schema for created_by:
    Crn string
    (String) The cloud resource name (CRN) of the broker.
    DeletedAt string
    (String) The time when the service broker was deleted.
    DeletedBies List<OnboardingResourceBrokerDeletedBy>
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    Guid string
    (String) The globally unique identifier of the broker.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    (String) The time when the service broker was updated.
    UpdatedBies List<OnboardingResourceBrokerUpdatedBy>
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    Url string
    (String) The URL associated with the broker.
    AccountId string
    (String) The ID of the account in which you manage the broker.
    CreatedAt string
    (String) The time when the service broker was created.
    CreatedBies []OnboardingResourceBrokerCreatedBy
    (List) The details of the user who created this broker. Nested schema for created_by:
    Crn string
    (String) The cloud resource name (CRN) of the broker.
    DeletedAt string
    (String) The time when the service broker was deleted.
    DeletedBies []OnboardingResourceBrokerDeletedBy
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    Guid string
    (String) The globally unique identifier of the broker.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    (String) The time when the service broker was updated.
    UpdatedBies []OnboardingResourceBrokerUpdatedBy
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    Url string
    (String) The URL associated with the broker.
    accountId String
    (String) The ID of the account in which you manage the broker.
    createdAt String
    (String) The time when the service broker was created.
    createdBies List<OnboardingResourceBrokerCreatedBy>
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn String
    (String) The cloud resource name (CRN) of the broker.
    deletedAt String
    (String) The time when the service broker was deleted.
    deletedBies List<OnboardingResourceBrokerDeletedBy>
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    guid String
    (String) The globally unique identifier of the broker.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    (String) The time when the service broker was updated.
    updatedBies List<OnboardingResourceBrokerUpdatedBy>
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url String
    (String) The URL associated with the broker.
    accountId string
    (String) The ID of the account in which you manage the broker.
    createdAt string
    (String) The time when the service broker was created.
    createdBies OnboardingResourceBrokerCreatedBy[]
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn string
    (String) The cloud resource name (CRN) of the broker.
    deletedAt string
    (String) The time when the service broker was deleted.
    deletedBies OnboardingResourceBrokerDeletedBy[]
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    guid string
    (String) The globally unique identifier of the broker.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    (String) The time when the service broker was updated.
    updatedBies OnboardingResourceBrokerUpdatedBy[]
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url string
    (String) The URL associated with the broker.
    account_id str
    (String) The ID of the account in which you manage the broker.
    created_at str
    (String) The time when the service broker was created.
    created_bies Sequence[OnboardingResourceBrokerCreatedBy]
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn str
    (String) The cloud resource name (CRN) of the broker.
    deleted_at str
    (String) The time when the service broker was deleted.
    deleted_bies Sequence[OnboardingResourceBrokerDeletedBy]
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    guid str
    (String) The globally unique identifier of the broker.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    (String) The time when the service broker was updated.
    updated_bies Sequence[OnboardingResourceBrokerUpdatedBy]
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url str
    (String) The URL associated with the broker.
    accountId String
    (String) The ID of the account in which you manage the broker.
    createdAt String
    (String) The time when the service broker was created.
    createdBies List<Property Map>
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn String
    (String) The cloud resource name (CRN) of the broker.
    deletedAt String
    (String) The time when the service broker was deleted.
    deletedBies List<Property Map>
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    guid String
    (String) The globally unique identifier of the broker.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    (String) The time when the service broker was updated.
    updatedBies List<Property Map>
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url String
    (String) The URL associated with the broker.

    Look up Existing OnboardingResourceBroker Resource

    Get an existing OnboardingResourceBroker 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?: OnboardingResourceBrokerState, opts?: CustomResourceOptions): OnboardingResourceBroker
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        allow_context_updates: Optional[bool] = None,
        auth_password: Optional[str] = None,
        auth_scheme: Optional[str] = None,
        auth_username: Optional[str] = None,
        broker_url: Optional[str] = None,
        catalog_type: Optional[str] = None,
        created_at: Optional[str] = None,
        created_bies: Optional[Sequence[OnboardingResourceBrokerCreatedByArgs]] = None,
        crn: Optional[str] = None,
        deleted_at: Optional[str] = None,
        deleted_bies: Optional[Sequence[OnboardingResourceBrokerDeletedByArgs]] = None,
        env: Optional[str] = None,
        guid: Optional[str] = None,
        name: Optional[str] = None,
        onboarding_resource_broker_id: Optional[str] = None,
        region: Optional[str] = None,
        resource_group_crn: Optional[str] = None,
        state: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_bies: Optional[Sequence[OnboardingResourceBrokerUpdatedByArgs]] = None,
        url: Optional[str] = None) -> OnboardingResourceBroker
    func GetOnboardingResourceBroker(ctx *Context, name string, id IDInput, state *OnboardingResourceBrokerState, opts ...ResourceOption) (*OnboardingResourceBroker, error)
    public static OnboardingResourceBroker Get(string name, Input<string> id, OnboardingResourceBrokerState? state, CustomResourceOptions? opts = null)
    public static OnboardingResourceBroker get(String name, Output<String> id, OnboardingResourceBrokerState state, CustomResourceOptions options)
    resources:  _:    type: ibm:OnboardingResourceBroker    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    (String) The ID of the account in which you manage the broker.
    AllowContextUpdates bool
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    AuthPassword string
    The authentication password to reach the broker.
    AuthScheme string
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    AuthUsername string
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    BrokerUrl string
    The URL associated with the broker application.
    CatalogType string
    To enable the provisioning of your broker, set this parameter value to service.
    CreatedAt string
    (String) The time when the service broker was created.
    CreatedBies List<OnboardingResourceBrokerCreatedBy>
    (List) The details of the user who created this broker. Nested schema for created_by:
    Crn string
    (String) The cloud resource name (CRN) of the broker.
    DeletedAt string
    (String) The time when the service broker was deleted.
    DeletedBies List<OnboardingResourceBrokerDeletedBy>
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    Env string
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    Guid string
    (String) The globally unique identifier of the broker.
    Name string
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    OnboardingResourceBrokerId string
    The unique identifier of the onboarding_resource_broker.
    Region string
    The region where the pricing plan is available.
    ResourceGroupCrn string
    The cloud resource name of the resource group.
    State string
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    Type string
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    UpdatedAt string
    (String) The time when the service broker was updated.
    UpdatedBies List<OnboardingResourceBrokerUpdatedBy>
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    Url string
    (String) The URL associated with the broker.
    AccountId string
    (String) The ID of the account in which you manage the broker.
    AllowContextUpdates bool
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    AuthPassword string
    The authentication password to reach the broker.
    AuthScheme string
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    AuthUsername string
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    BrokerUrl string
    The URL associated with the broker application.
    CatalogType string
    To enable the provisioning of your broker, set this parameter value to service.
    CreatedAt string
    (String) The time when the service broker was created.
    CreatedBies []OnboardingResourceBrokerCreatedByArgs
    (List) The details of the user who created this broker. Nested schema for created_by:
    Crn string
    (String) The cloud resource name (CRN) of the broker.
    DeletedAt string
    (String) The time when the service broker was deleted.
    DeletedBies []OnboardingResourceBrokerDeletedByArgs
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    Env string
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    Guid string
    (String) The globally unique identifier of the broker.
    Name string
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    OnboardingResourceBrokerId string
    The unique identifier of the onboarding_resource_broker.
    Region string
    The region where the pricing plan is available.
    ResourceGroupCrn string
    The cloud resource name of the resource group.
    State string
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    Type string
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    UpdatedAt string
    (String) The time when the service broker was updated.
    UpdatedBies []OnboardingResourceBrokerUpdatedByArgs
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    Url string
    (String) The URL associated with the broker.
    accountId String
    (String) The ID of the account in which you manage the broker.
    allowContextUpdates Boolean
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    authPassword String
    The authentication password to reach the broker.
    authScheme String
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    authUsername String
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    brokerUrl String
    The URL associated with the broker application.
    catalogType String
    To enable the provisioning of your broker, set this parameter value to service.
    createdAt String
    (String) The time when the service broker was created.
    createdBies List<OnboardingResourceBrokerCreatedBy>
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn String
    (String) The cloud resource name (CRN) of the broker.
    deletedAt String
    (String) The time when the service broker was deleted.
    deletedBies List<OnboardingResourceBrokerDeletedBy>
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    env String
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    guid String
    (String) The globally unique identifier of the broker.
    name String
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboardingResourceBrokerId String
    The unique identifier of the onboarding_resource_broker.
    region String
    The region where the pricing plan is available.
    resourceGroupCrn String
    The cloud resource name of the resource group.
    state String
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    type String
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    updatedAt String
    (String) The time when the service broker was updated.
    updatedBies List<OnboardingResourceBrokerUpdatedBy>
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url String
    (String) The URL associated with the broker.
    accountId string
    (String) The ID of the account in which you manage the broker.
    allowContextUpdates boolean
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    authPassword string
    The authentication password to reach the broker.
    authScheme string
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    authUsername string
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    brokerUrl string
    The URL associated with the broker application.
    catalogType string
    To enable the provisioning of your broker, set this parameter value to service.
    createdAt string
    (String) The time when the service broker was created.
    createdBies OnboardingResourceBrokerCreatedBy[]
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn string
    (String) The cloud resource name (CRN) of the broker.
    deletedAt string
    (String) The time when the service broker was deleted.
    deletedBies OnboardingResourceBrokerDeletedBy[]
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    env string
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    guid string
    (String) The globally unique identifier of the broker.
    name string
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboardingResourceBrokerId string
    The unique identifier of the onboarding_resource_broker.
    region string
    The region where the pricing plan is available.
    resourceGroupCrn string
    The cloud resource name of the resource group.
    state string
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    type string
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    updatedAt string
    (String) The time when the service broker was updated.
    updatedBies OnboardingResourceBrokerUpdatedBy[]
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url string
    (String) The URL associated with the broker.
    account_id str
    (String) The ID of the account in which you manage the broker.
    allow_context_updates bool
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    auth_password str
    The authentication password to reach the broker.
    auth_scheme str
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    auth_username str
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    broker_url str
    The URL associated with the broker application.
    catalog_type str
    To enable the provisioning of your broker, set this parameter value to service.
    created_at str
    (String) The time when the service broker was created.
    created_bies Sequence[OnboardingResourceBrokerCreatedByArgs]
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn str
    (String) The cloud resource name (CRN) of the broker.
    deleted_at str
    (String) The time when the service broker was deleted.
    deleted_bies Sequence[OnboardingResourceBrokerDeletedByArgs]
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    env str
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    guid str
    (String) The globally unique identifier of the broker.
    name str
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboarding_resource_broker_id str
    The unique identifier of the onboarding_resource_broker.
    region str
    The region where the pricing plan is available.
    resource_group_crn str
    The cloud resource name of the resource group.
    state str
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    type str
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    updated_at str
    (String) The time when the service broker was updated.
    updated_bies Sequence[OnboardingResourceBrokerUpdatedByArgs]
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url str
    (String) The URL associated with the broker.
    accountId String
    (String) The ID of the account in which you manage the broker.
    allowContextUpdates Boolean
    Whether the resource controller will call the broker for any context changes to the instance. Currently, the only context related change is an instance name update.
    authPassword String
    The authentication password to reach the broker.
    authScheme String
    The supported authentication scheme for the broker.

    • Constraints: Allowable values are: bearer, bearer-crn.
    authUsername String
    The authentication username to reach the broker.

    • Constraints: Allowable values are: apikey.
    brokerUrl String
    The URL associated with the broker application.
    catalogType String
    To enable the provisioning of your broker, set this parameter value to service.
    createdAt String
    (String) The time when the service broker was created.
    createdBies List<Property Map>
    (List) The details of the user who created this broker. Nested schema for created_by:
    crn String
    (String) The cloud resource name (CRN) of the broker.
    deletedAt String
    (String) The time when the service broker was deleted.
    deletedBies List<Property Map>
    (List) The details of the user who deleted this broker. Nested schema for deleted_by:
    env String
    The environment to fetch this object from.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^[a-z_.-]+$/.
    guid String
    (String) The globally unique identifier of the broker.
    name String
    The name of the broker.

    • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[ -~\\s]*$/.
    onboardingResourceBrokerId String
    The unique identifier of the onboarding_resource_broker.
    region String
    The region where the pricing plan is available.
    resourceGroupCrn String
    The cloud resource name of the resource group.
    state String
    The state of the broker.

    • Constraints: Allowable values are: active, removed.
    type String
    The type of the provisioning model.

    • Constraints: Allowable values are: provision_through, provision_behind.
    updatedAt String
    (String) The time when the service broker was updated.
    updatedBies List<Property Map>
    (List) The details of the user who updated this broker. Nested schema for updated_by:
    url String
    (String) The URL associated with the broker.

    Supporting Types

    OnboardingResourceBrokerCreatedBy, OnboardingResourceBrokerCreatedByArgs

    UserId string
    (String) The ID of the user who dispatched this action.
    UserName string
    (String) The username of the user who dispatched this action.
    UserId string
    (String) The ID of the user who dispatched this action.
    UserName string
    (String) The username of the user who dispatched this action.
    userId String
    (String) The ID of the user who dispatched this action.
    userName String
    (String) The username of the user who dispatched this action.
    userId string
    (String) The ID of the user who dispatched this action.
    userName string
    (String) The username of the user who dispatched this action.
    user_id str
    (String) The ID of the user who dispatched this action.
    user_name str
    (String) The username of the user who dispatched this action.
    userId String
    (String) The ID of the user who dispatched this action.
    userName String
    (String) The username of the user who dispatched this action.

    OnboardingResourceBrokerDeletedBy, OnboardingResourceBrokerDeletedByArgs

    UserId string
    (String) The ID of the user who dispatched this action.
    UserName string
    (String) The username of the user who dispatched this action.
    UserId string
    (String) The ID of the user who dispatched this action.
    UserName string
    (String) The username of the user who dispatched this action.
    userId String
    (String) The ID of the user who dispatched this action.
    userName String
    (String) The username of the user who dispatched this action.
    userId string
    (String) The ID of the user who dispatched this action.
    userName string
    (String) The username of the user who dispatched this action.
    user_id str
    (String) The ID of the user who dispatched this action.
    user_name str
    (String) The username of the user who dispatched this action.
    userId String
    (String) The ID of the user who dispatched this action.
    userName String
    (String) The username of the user who dispatched this action.

    OnboardingResourceBrokerUpdatedBy, OnboardingResourceBrokerUpdatedByArgs

    UserId string
    (String) The ID of the user who dispatched this action.
    UserName string
    (String) The username of the user who dispatched this action.
    UserId string
    (String) The ID of the user who dispatched this action.
    UserName string
    (String) The username of the user who dispatched this action.
    userId String
    (String) The ID of the user who dispatched this action.
    userName String
    (String) The username of the user who dispatched this action.
    userId string
    (String) The ID of the user who dispatched this action.
    userName string
    (String) The username of the user who dispatched this action.
    user_id str
    (String) The ID of the user who dispatched this action.
    user_name str
    (String) The username of the user who dispatched this action.
    userId String
    (String) The ID of the user who dispatched this action.
    userName String
    (String) The username of the user who dispatched this action.

    Import

    You can import the ibm_onboarding_resource_broker resource by using id. The identifier of the broker.

    Syntax

    
```sh
$ pulumi import ibm:index/onboardingResourceBroker:OnboardingResourceBroker onboarding_resource_broker id;
```

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm