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

ibm.OnboardingProduct

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 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_products with this resource.

Example Usage

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

const onboardingProductInstance = new ibm.OnboardingProduct("onboardingProductInstance", {
    primaryContact: {
        email: "email",
        name: "name",
    },
    support: {
        escalationContacts: [{
            email: "email",
            name: "name",
            role: "role",
        }],
    },
    type: "service",
});
Copy
import pulumi
import pulumi_ibm as ibm

onboarding_product_instance = ibm.OnboardingProduct("onboardingProductInstance",
    primary_contact={
        "email": "email",
        "name": "name",
    },
    support={
        "escalation_contacts": [{
            "email": "email",
            "name": "name",
            "role": "role",
        }],
    },
    type="service")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewOnboardingProduct(ctx, "onboardingProductInstance", &ibm.OnboardingProductArgs{
			PrimaryContact: &ibm.OnboardingProductPrimaryContactArgs{
				Email: pulumi.String("email"),
				Name:  pulumi.String("name"),
			},
			Support: &ibm.OnboardingProductSupportArgs{
				EscalationContacts: ibm.OnboardingProductSupportEscalationContactArray{
					&ibm.OnboardingProductSupportEscalationContactArgs{
						Email: pulumi.String("email"),
						Name:  pulumi.String("name"),
						Role:  pulumi.String("role"),
					},
				},
			},
			Type: pulumi.String("service"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var onboardingProductInstance = new Ibm.OnboardingProduct("onboardingProductInstance", new()
    {
        PrimaryContact = new Ibm.Inputs.OnboardingProductPrimaryContactArgs
        {
            Email = "email",
            Name = "name",
        },
        Support = new Ibm.Inputs.OnboardingProductSupportArgs
        {
            EscalationContacts = new[]
            {
                new Ibm.Inputs.OnboardingProductSupportEscalationContactArgs
                {
                    Email = "email",
                    Name = "name",
                    Role = "role",
                },
            },
        },
        Type = "service",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.OnboardingProduct;
import com.pulumi.ibm.OnboardingProductArgs;
import com.pulumi.ibm.inputs.OnboardingProductPrimaryContactArgs;
import com.pulumi.ibm.inputs.OnboardingProductSupportArgs;
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 onboardingProductInstance = new OnboardingProduct("onboardingProductInstance", OnboardingProductArgs.builder()
            .primaryContact(OnboardingProductPrimaryContactArgs.builder()
                .email("email")
                .name("name")
                .build())
            .support(OnboardingProductSupportArgs.builder()
                .escalationContacts(OnboardingProductSupportEscalationContactArgs.builder()
                    .email("email")
                    .name("name")
                    .role("role")
                    .build())
                .build())
            .type("service")
            .build());

    }
}
Copy
resources:
  onboardingProductInstance:
    type: ibm:OnboardingProduct
    properties:
      primaryContact:
        email: email
        name: name
      support:
        escalationContacts:
          - email: email
            name: name
            role: role
      type: service
Copy

Create OnboardingProduct Resource

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

Constructor syntax

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

@overload
def OnboardingProduct(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      primary_contact: Optional[OnboardingProductPrimaryContactArgs] = None,
                      type: Optional[str] = None,
                      eccn_number: Optional[str] = None,
                      ero_class: Optional[str] = None,
                      onboarding_product_id: Optional[str] = None,
                      support: Optional[OnboardingProductSupportArgs] = None,
                      tax_assessment: Optional[str] = None,
                      unspsc: Optional[float] = None)
func NewOnboardingProduct(ctx *Context, name string, args OnboardingProductArgs, opts ...ResourceOption) (*OnboardingProduct, error)
public OnboardingProduct(string name, OnboardingProductArgs args, CustomResourceOptions? opts = null)
public OnboardingProduct(String name, OnboardingProductArgs args)
public OnboardingProduct(String name, OnboardingProductArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OnboardingProductArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OnboardingProductArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OnboardingProductArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OnboardingProductArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OnboardingProductArgs
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 onboardingProductResource = new Ibm.OnboardingProduct("onboardingProductResource", new()
{
    PrimaryContact = new Ibm.Inputs.OnboardingProductPrimaryContactArgs
    {
        Email = "string",
        Name = "string",
    },
    Type = "string",
    EccnNumber = "string",
    EroClass = "string",
    OnboardingProductId = "string",
    Support = new Ibm.Inputs.OnboardingProductSupportArgs
    {
        EscalationContacts = new[]
        {
            new Ibm.Inputs.OnboardingProductSupportEscalationContactArgs
            {
                Email = "string",
                Name = "string",
                Role = "string",
            },
        },
    },
    TaxAssessment = "string",
    Unspsc = 0,
});
Copy
example, err := ibm.NewOnboardingProduct(ctx, "onboardingProductResource", &ibm.OnboardingProductArgs{
PrimaryContact: &.OnboardingProductPrimaryContactArgs{
Email: pulumi.String("string"),
Name: pulumi.String("string"),
},
Type: pulumi.String("string"),
EccnNumber: pulumi.String("string"),
EroClass: pulumi.String("string"),
OnboardingProductId: pulumi.String("string"),
Support: &.OnboardingProductSupportArgs{
EscalationContacts: .OnboardingProductSupportEscalationContactArray{
&.OnboardingProductSupportEscalationContactArgs{
Email: pulumi.String("string"),
Name: pulumi.String("string"),
Role: pulumi.String("string"),
},
},
},
TaxAssessment: pulumi.String("string"),
Unspsc: pulumi.Float64(0),
})
Copy
var onboardingProductResource = new OnboardingProduct("onboardingProductResource", OnboardingProductArgs.builder()
    .primaryContact(OnboardingProductPrimaryContactArgs.builder()
        .email("string")
        .name("string")
        .build())
    .type("string")
    .eccnNumber("string")
    .eroClass("string")
    .onboardingProductId("string")
    .support(OnboardingProductSupportArgs.builder()
        .escalationContacts(OnboardingProductSupportEscalationContactArgs.builder()
            .email("string")
            .name("string")
            .role("string")
            .build())
        .build())
    .taxAssessment("string")
    .unspsc(0)
    .build());
Copy
onboarding_product_resource = ibm.OnboardingProduct("onboardingProductResource",
    primary_contact={
        "email": "string",
        "name": "string",
    },
    type="string",
    eccn_number="string",
    ero_class="string",
    onboarding_product_id="string",
    support={
        "escalation_contacts": [{
            "email": "string",
            "name": "string",
            "role": "string",
        }],
    },
    tax_assessment="string",
    unspsc=0)
Copy
const onboardingProductResource = new ibm.OnboardingProduct("onboardingProductResource", {
    primaryContact: {
        email: "string",
        name: "string",
    },
    type: "string",
    eccnNumber: "string",
    eroClass: "string",
    onboardingProductId: "string",
    support: {
        escalationContacts: [{
            email: "string",
            name: "string",
            role: "string",
        }],
    },
    taxAssessment: "string",
    unspsc: 0,
});
Copy
type: ibm:OnboardingProduct
properties:
    eccnNumber: string
    eroClass: string
    onboardingProductId: string
    primaryContact:
        email: string
        name: string
    support:
        escalationContacts:
            - email: string
              name: string
              role: string
    taxAssessment: string
    type: string
    unspsc: 0
Copy

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

PrimaryContact This property is required. OnboardingProductPrimaryContact
The primary contact for your product. Nested schema for primary_contact:
Type This property is required. string
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
EccnNumber string
The Export Control Classification Number of your product.
EroClass string
The ERO class of your product.
OnboardingProductId string
The unique identifier of the onboarding_product.
Support OnboardingProductSupport
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
TaxAssessment string
The tax assessment type of your product.
Unspsc double
The United Nations Standard Products and Services Code of your product.
PrimaryContact This property is required. OnboardingProductPrimaryContactArgs
The primary contact for your product. Nested schema for primary_contact:
Type This property is required. string
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
EccnNumber string
The Export Control Classification Number of your product.
EroClass string
The ERO class of your product.
OnboardingProductId string
The unique identifier of the onboarding_product.
Support OnboardingProductSupportArgs
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
TaxAssessment string
The tax assessment type of your product.
Unspsc float64
The United Nations Standard Products and Services Code of your product.
primaryContact This property is required. OnboardingProductPrimaryContact
The primary contact for your product. Nested schema for primary_contact:
type This property is required. String
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
eccnNumber String
The Export Control Classification Number of your product.
eroClass String
The ERO class of your product.
onboardingProductId String
The unique identifier of the onboarding_product.
support OnboardingProductSupport
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
taxAssessment String
The tax assessment type of your product.
unspsc Double
The United Nations Standard Products and Services Code of your product.
primaryContact This property is required. OnboardingProductPrimaryContact
The primary contact for your product. Nested schema for primary_contact:
type This property is required. string
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
eccnNumber string
The Export Control Classification Number of your product.
eroClass string
The ERO class of your product.
onboardingProductId string
The unique identifier of the onboarding_product.
support OnboardingProductSupport
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
taxAssessment string
The tax assessment type of your product.
unspsc number
The United Nations Standard Products and Services Code of your product.
primary_contact This property is required. OnboardingProductPrimaryContactArgs
The primary contact for your product. Nested schema for primary_contact:
type This property is required. str
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
eccn_number str
The Export Control Classification Number of your product.
ero_class str
The ERO class of your product.
onboarding_product_id str
The unique identifier of the onboarding_product.
support OnboardingProductSupportArgs
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
tax_assessment str
The tax assessment type of your product.
unspsc float
The United Nations Standard Products and Services Code of your product.
primaryContact This property is required. Property Map
The primary contact for your product. Nested schema for primary_contact:
type This property is required. String
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
eccnNumber String
The Export Control Classification Number of your product.
eroClass String
The ERO class of your product.
onboardingProductId String
The unique identifier of the onboarding_product.
support Property Map
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
taxAssessment String
The tax assessment type of your product.
unspsc Number
The United Nations Standard Products and Services Code of your product.

Outputs

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

AccountId string
(String) The IBM Cloud account ID of the provider.
ApproverResourceId string
(String) The ID of the approval workflow of your product.
GlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
IamRegistrationId string
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
Id string
The provider-assigned unique ID for this managed resource.
PrivateCatalogId string
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
PrivateCatalogOfferingId string
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
StagingGlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
AccountId string
(String) The IBM Cloud account ID of the provider.
ApproverResourceId string
(String) The ID of the approval workflow of your product.
GlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
IamRegistrationId string
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
Id string
The provider-assigned unique ID for this managed resource.
PrivateCatalogId string
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
PrivateCatalogOfferingId string
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
StagingGlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
accountId String
(String) The IBM Cloud account ID of the provider.
approverResourceId String
(String) The ID of the approval workflow of your product.
globalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iamRegistrationId String
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
id String
The provider-assigned unique ID for this managed resource.
privateCatalogId String
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
privateCatalogOfferingId String
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
stagingGlobalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
accountId string
(String) The IBM Cloud account ID of the provider.
approverResourceId string
(String) The ID of the approval workflow of your product.
globalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iamRegistrationId string
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
id string
The provider-assigned unique ID for this managed resource.
privateCatalogId string
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
privateCatalogOfferingId string
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
stagingGlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
account_id str
(String) The IBM Cloud account ID of the provider.
approver_resource_id str
(String) The ID of the approval workflow of your product.
global_catalog_offering_id str
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iam_registration_id str
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
id str
The provider-assigned unique ID for this managed resource.
private_catalog_id str
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
private_catalog_offering_id str
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
staging_global_catalog_offering_id str
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
accountId String
(String) The IBM Cloud account ID of the provider.
approverResourceId String
(String) The ID of the approval workflow of your product.
globalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iamRegistrationId String
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
id String
The provider-assigned unique ID for this managed resource.
privateCatalogId String
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
privateCatalogOfferingId String
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
stagingGlobalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.

Look up Existing OnboardingProduct Resource

Get an existing OnboardingProduct 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?: OnboardingProductState, opts?: CustomResourceOptions): OnboardingProduct
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        approver_resource_id: Optional[str] = None,
        eccn_number: Optional[str] = None,
        ero_class: Optional[str] = None,
        global_catalog_offering_id: Optional[str] = None,
        iam_registration_id: Optional[str] = None,
        onboarding_product_id: Optional[str] = None,
        primary_contact: Optional[OnboardingProductPrimaryContactArgs] = None,
        private_catalog_id: Optional[str] = None,
        private_catalog_offering_id: Optional[str] = None,
        staging_global_catalog_offering_id: Optional[str] = None,
        support: Optional[OnboardingProductSupportArgs] = None,
        tax_assessment: Optional[str] = None,
        type: Optional[str] = None,
        unspsc: Optional[float] = None) -> OnboardingProduct
func GetOnboardingProduct(ctx *Context, name string, id IDInput, state *OnboardingProductState, opts ...ResourceOption) (*OnboardingProduct, error)
public static OnboardingProduct Get(string name, Input<string> id, OnboardingProductState? state, CustomResourceOptions? opts = null)
public static OnboardingProduct get(String name, Output<String> id, OnboardingProductState state, CustomResourceOptions options)
resources:  _:    type: ibm:OnboardingProduct    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId string
(String) The IBM Cloud account ID of the provider.
ApproverResourceId string
(String) The ID of the approval workflow of your product.
EccnNumber string
The Export Control Classification Number of your product.
EroClass string
The ERO class of your product.
GlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
IamRegistrationId string
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
OnboardingProductId string
The unique identifier of the onboarding_product.
PrimaryContact OnboardingProductPrimaryContact
The primary contact for your product. Nested schema for primary_contact:
PrivateCatalogId string
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
PrivateCatalogOfferingId string
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
StagingGlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
Support OnboardingProductSupport
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
TaxAssessment string
The tax assessment type of your product.
Type string
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
Unspsc double
The United Nations Standard Products and Services Code of your product.
AccountId string
(String) The IBM Cloud account ID of the provider.
ApproverResourceId string
(String) The ID of the approval workflow of your product.
EccnNumber string
The Export Control Classification Number of your product.
EroClass string
The ERO class of your product.
GlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
IamRegistrationId string
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
OnboardingProductId string
The unique identifier of the onboarding_product.
PrimaryContact OnboardingProductPrimaryContactArgs
The primary contact for your product. Nested schema for primary_contact:
PrivateCatalogId string
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
PrivateCatalogOfferingId string
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
StagingGlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
Support OnboardingProductSupportArgs
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
TaxAssessment string
The tax assessment type of your product.
Type string
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
Unspsc float64
The United Nations Standard Products and Services Code of your product.
accountId String
(String) The IBM Cloud account ID of the provider.
approverResourceId String
(String) The ID of the approval workflow of your product.
eccnNumber String
The Export Control Classification Number of your product.
eroClass String
The ERO class of your product.
globalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iamRegistrationId String
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
onboardingProductId String
The unique identifier of the onboarding_product.
primaryContact OnboardingProductPrimaryContact
The primary contact for your product. Nested schema for primary_contact:
privateCatalogId String
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
privateCatalogOfferingId String
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
stagingGlobalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
support OnboardingProductSupport
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
taxAssessment String
The tax assessment type of your product.
type String
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
unspsc Double
The United Nations Standard Products and Services Code of your product.
accountId string
(String) The IBM Cloud account ID of the provider.
approverResourceId string
(String) The ID of the approval workflow of your product.
eccnNumber string
The Export Control Classification Number of your product.
eroClass string
The ERO class of your product.
globalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iamRegistrationId string
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
onboardingProductId string
The unique identifier of the onboarding_product.
primaryContact OnboardingProductPrimaryContact
The primary contact for your product. Nested schema for primary_contact:
privateCatalogId string
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
privateCatalogOfferingId string
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
stagingGlobalCatalogOfferingId string
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
support OnboardingProductSupport
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
taxAssessment string
The tax assessment type of your product.
type string
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
unspsc number
The United Nations Standard Products and Services Code of your product.
account_id str
(String) The IBM Cloud account ID of the provider.
approver_resource_id str
(String) The ID of the approval workflow of your product.
eccn_number str
The Export Control Classification Number of your product.
ero_class str
The ERO class of your product.
global_catalog_offering_id str
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iam_registration_id str
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
onboarding_product_id str
The unique identifier of the onboarding_product.
primary_contact OnboardingProductPrimaryContactArgs
The primary contact for your product. Nested schema for primary_contact:
private_catalog_id str
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
private_catalog_offering_id str
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
staging_global_catalog_offering_id str
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
support OnboardingProductSupportArgs
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
tax_assessment str
The tax assessment type of your product.
type str
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
unspsc float
The United Nations Standard Products and Services Code of your product.
accountId String
(String) The IBM Cloud account ID of the provider.
approverResourceId String
(String) The ID of the approval workflow of your product.
eccnNumber String
The Export Control Classification Number of your product.
eroClass String
The ERO class of your product.
globalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
iamRegistrationId String
(String) IAM registration identifier.

  • Constraints: The maximum length is 512 characters. The minimum length is 2 characters. The value must match regular expression /^\\S*$/.
onboardingProductId String
The unique identifier of the onboarding_product.
primaryContact Property Map
The primary contact for your product. Nested schema for primary_contact:
privateCatalogId String
(String) The ID of the private catalog that contains the product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
privateCatalogOfferingId String
(String) The ID of the linked private catalog product. Only applicable for software type products.

  • Constraints: The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
stagingGlobalCatalogOfferingId String
(String) The ID of a global catalog object.

  • Constraints: The value must match regular expression /^\\S*$/.
support Property Map
The support information that is not displayed in the catalog, but available in ServiceNow. Nested schema for support:
taxAssessment String
The tax assessment type of your product.
type String
The type of the product.

  • Constraints: Allowable values are: software, service, professional_service.
unspsc Number
The United Nations Standard Products and Services Code of your product.

Supporting Types

OnboardingProductPrimaryContact
, OnboardingProductPrimaryContactArgs

Email This property is required. string
The email address of the primary contact for your product.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^\\S+@\\S+$/.
Name This property is required. string
The name of the primary contact for your product.

  • Constraints: The maximum length is 64 characters. The minimum length is 1 character.
Email This property is required. string
The email address of the primary contact for your product.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^\\S+@\\S+$/.
Name This property is required. string
The name of the primary contact for your product.

  • Constraints: The maximum length is 64 characters. The minimum length is 1 character.
email This property is required. String
The email address of the primary contact for your product.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^\\S+@\\S+$/.
name This property is required. String
The name of the primary contact for your product.

  • Constraints: The maximum length is 64 characters. The minimum length is 1 character.
email This property is required. string
The email address of the primary contact for your product.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^\\S+@\\S+$/.
name This property is required. string
The name of the primary contact for your product.

  • Constraints: The maximum length is 64 characters. The minimum length is 1 character.
email This property is required. str
The email address of the primary contact for your product.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^\\S+@\\S+$/.
name This property is required. str
The name of the primary contact for your product.

  • Constraints: The maximum length is 64 characters. The minimum length is 1 character.
email This property is required. String
The email address of the primary contact for your product.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^\\S+@\\S+$/.
name This property is required. String
The name of the primary contact for your product.

  • Constraints: The maximum length is 64 characters. The minimum length is 1 character.

OnboardingProductSupport
, OnboardingProductSupportArgs

EscalationContacts List<OnboardingProductSupportEscalationContact>
The list of contacts in case of support escalations.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for escalation_contacts:
EscalationContacts []OnboardingProductSupportEscalationContact
The list of contacts in case of support escalations.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for escalation_contacts:
escalationContacts List<OnboardingProductSupportEscalationContact>
The list of contacts in case of support escalations.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for escalation_contacts:
escalationContacts OnboardingProductSupportEscalationContact[]
The list of contacts in case of support escalations.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for escalation_contacts:
escalation_contacts Sequence[OnboardingProductSupportEscalationContact]
The list of contacts in case of support escalations.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for escalation_contacts:
escalationContacts List<Property Map>
The list of contacts in case of support escalations.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for escalation_contacts:

OnboardingProductSupportEscalationContact
, OnboardingProductSupportEscalationContactArgs

Email string
The email address of the support escalation contact.
Name string
The name of the support escalation contact.
Role string
The role of the support escalation contact.
Email string
The email address of the support escalation contact.
Name string
The name of the support escalation contact.
Role string
The role of the support escalation contact.
email String
The email address of the support escalation contact.
name String
The name of the support escalation contact.
role String
The role of the support escalation contact.
email string
The email address of the support escalation contact.
name string
The name of the support escalation contact.
role string
The role of the support escalation contact.
email str
The email address of the support escalation contact.
name str
The name of the support escalation contact.
role str
The role of the support escalation contact.
email String
The email address of the support escalation contact.
name String
The name of the support escalation contact.
role String
The role of the support escalation contact.

Import

You can import the ibm_onboarding_product resource by using id. The ID of a product in Partner Center - Sell.

Syntax

```sh
$ pulumi import ibm:index/onboardingProduct:OnboardingProduct onboarding_product 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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm