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

ibm.Enterprise

Explore with Pulumi AI

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

    Create and update an enterprise. Delete operation is not supported. For more information, about enterprise management, refer to setting up an enterprise.

    Example Usage

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

const enterprise = new ibm.Enterprise("enterprise", {
    primaryContactIamId: "primary_contact_iam_id",
    sourceAccountId: "source_account_id",
});

    import pulumi
import pulumi_ibm as ibm

enterprise = ibm.Enterprise("enterprise",
    primary_contact_iam_id="primary_contact_iam_id",
    source_account_id="source_account_id")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewEnterprise(ctx, "enterprise", &ibm.EnterpriseArgs{
			PrimaryContactIamId: pulumi.String("primary_contact_iam_id"),
			SourceAccountId:     pulumi.String("source_account_id"),
		})
		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 enterprise = new Ibm.Enterprise("enterprise", new()
    {
        PrimaryContactIamId = "primary_contact_iam_id",
        SourceAccountId = "source_account_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.Enterprise;
import com.pulumi.ibm.EnterpriseArgs;
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 enterprise = new Enterprise("enterprise", EnterpriseArgs.builder()
            .primaryContactIamId("primary_contact_iam_id")
            .sourceAccountId("source_account_id")
            .build());

    }
}

    resources:
  enterprise:
    type: ibm:Enterprise
    properties:
      primaryContactIamId: primary_contact_iam_id
      sourceAccountId: source_account_id

    Create Enterprise Resource

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

    Constructor syntax

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

@overload
def Enterprise(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               primary_contact_iam_id: Optional[str] = None,
               source_account_id: Optional[str] = None,
               domain: Optional[str] = None,
               enterprise_id: Optional[str] = None,
               name: Optional[str] = None,
               timeouts: Optional[EnterpriseTimeoutsArgs] = None)
    func NewEnterprise(ctx *Context, name string, args EnterpriseArgs, opts ...ResourceOption) (*Enterprise, error)
    public Enterprise(string name, EnterpriseArgs args, CustomResourceOptions? opts = null)
    public Enterprise(String name, EnterpriseArgs args)
public Enterprise(String name, EnterpriseArgs args, CustomResourceOptions options)

    type: ibm:Enterprise
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 EnterpriseArgs
    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 EnterpriseArgs
    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 EnterpriseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnterpriseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnterpriseArgs
    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 enterpriseResource = new Ibm.Enterprise("enterpriseResource", new()
{
    PrimaryContactIamId = "string",
    SourceAccountId = "string",
    Domain = "string",
    EnterpriseId = "string",
    Name = "string",
    Timeouts = new Ibm.Inputs.EnterpriseTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewEnterprise(ctx, "enterpriseResource", &ibm.EnterpriseArgs{
	PrimaryContactIamId: pulumi.String("string"),
	SourceAccountId:     pulumi.String("string"),
	Domain:              pulumi.String("string"),
	EnterpriseId:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	Timeouts: &ibm.EnterpriseTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var enterpriseResource = new Enterprise("enterpriseResource", EnterpriseArgs.builder()
    .primaryContactIamId("string")
    .sourceAccountId("string")
    .domain("string")
    .enterpriseId("string")
    .name("string")
    .timeouts(EnterpriseTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    enterprise_resource = ibm.Enterprise("enterpriseResource",
    primary_contact_iam_id="string",
    source_account_id="string",
    domain="string",
    enterprise_id="string",
    name="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const enterpriseResource = new ibm.Enterprise("enterpriseResource", {
    primaryContactIamId: "string",
    sourceAccountId: "string",
    domain: "string",
    enterpriseId: "string",
    name: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:Enterprise
properties:
    domain: string
    enterpriseId: string
    name: string
    primaryContactIamId: string
    sourceAccountId: string
    timeouts:
        create: string
        delete: string
        update: string

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

    PrimaryContactIamId string
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    SourceAccountId string
    The ID of an account that is used to create the enterprise.
    Domain string
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    EnterpriseId string
    (String) The unique identifier of an enterprise.
    Name string
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    Timeouts EnterpriseTimeouts
    PrimaryContactIamId string
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    SourceAccountId string
    The ID of an account that is used to create the enterprise.
    Domain string
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    EnterpriseId string
    (String) The unique identifier of an enterprise.
    Name string
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    Timeouts EnterpriseTimeoutsArgs
    primaryContactIamId String
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    sourceAccountId String
    The ID of an account that is used to create the enterprise.
    domain String
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterpriseId String
    (String) The unique identifier of an enterprise.
    name String
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    timeouts EnterpriseTimeouts
    primaryContactIamId string
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    sourceAccountId string
    The ID of an account that is used to create the enterprise.
    domain string
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterpriseId string
    (String) The unique identifier of an enterprise.
    name string
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    timeouts EnterpriseTimeouts
    primary_contact_iam_id str
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    source_account_id str
    The ID of an account that is used to create the enterprise.
    domain str
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterprise_id str
    (String) The unique identifier of an enterprise.
    name str
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    timeouts EnterpriseTimeoutsArgs
    primaryContactIamId String
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    sourceAccountId String
    The ID of an account that is used to create the enterprise.
    domain String
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterpriseId String
    (String) The unique identifier of an enterprise.
    name String
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    timeouts Property Map

    Outputs

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

    CreatedAt string
    (Timestamp) The time stamp at which an enterprise is created.
    CreatedBy string
    (String) The IAM ID of an user or service that created an enterprise.
    Crn string
    (String) The Cloud Resource Name (CRN) of an enterprise.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryContactEmail string
    (String) The Email of the primary contact of an enterprise.
    State string
    (String) The state of an enterprise.
    UpdatedAt string
    (Timestamp) The time stamp at which an enterprise was last updated.
    UpdatedBy string
    (String) The IAM ID of the user or service that updated an enterprise.
    Url string
    (String) The URL of an enterprise.
    CreatedAt string
    (Timestamp) The time stamp at which an enterprise is created.
    CreatedBy string
    (String) The IAM ID of an user or service that created an enterprise.
    Crn string
    (String) The Cloud Resource Name (CRN) of an enterprise.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryContactEmail string
    (String) The Email of the primary contact of an enterprise.
    State string
    (String) The state of an enterprise.
    UpdatedAt string
    (Timestamp) The time stamp at which an enterprise was last updated.
    UpdatedBy string
    (String) The IAM ID of the user or service that updated an enterprise.
    Url string
    (String) The URL of an enterprise.
    createdAt String
    (Timestamp) The time stamp at which an enterprise is created.
    createdBy String
    (String) The IAM ID of an user or service that created an enterprise.
    crn String
    (String) The Cloud Resource Name (CRN) of an enterprise.
    enterpriseAccountId String
    (String) The enterprise account ID.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryContactEmail String
    (String) The Email of the primary contact of an enterprise.
    state String
    (String) The state of an enterprise.
    updatedAt String
    (Timestamp) The time stamp at which an enterprise was last updated.
    updatedBy String
    (String) The IAM ID of the user or service that updated an enterprise.
    url String
    (String) The URL of an enterprise.
    createdAt string
    (Timestamp) The time stamp at which an enterprise is created.
    createdBy string
    (String) The IAM ID of an user or service that created an enterprise.
    crn string
    (String) The Cloud Resource Name (CRN) of an enterprise.
    enterpriseAccountId string
    (String) The enterprise account ID.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryContactEmail string
    (String) The Email of the primary contact of an enterprise.
    state string
    (String) The state of an enterprise.
    updatedAt string
    (Timestamp) The time stamp at which an enterprise was last updated.
    updatedBy string
    (String) The IAM ID of the user or service that updated an enterprise.
    url string
    (String) The URL of an enterprise.
    created_at str
    (Timestamp) The time stamp at which an enterprise is created.
    created_by str
    (String) The IAM ID of an user or service that created an enterprise.
    crn str
    (String) The Cloud Resource Name (CRN) of an enterprise.
    enterprise_account_id str
    (String) The enterprise account ID.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_contact_email str
    (String) The Email of the primary contact of an enterprise.
    state str
    (String) The state of an enterprise.
    updated_at str
    (Timestamp) The time stamp at which an enterprise was last updated.
    updated_by str
    (String) The IAM ID of the user or service that updated an enterprise.
    url str
    (String) The URL of an enterprise.
    createdAt String
    (Timestamp) The time stamp at which an enterprise is created.
    createdBy String
    (String) The IAM ID of an user or service that created an enterprise.
    crn String
    (String) The Cloud Resource Name (CRN) of an enterprise.
    enterpriseAccountId String
    (String) The enterprise account ID.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryContactEmail String
    (String) The Email of the primary contact of an enterprise.
    state String
    (String) The state of an enterprise.
    updatedAt String
    (Timestamp) The time stamp at which an enterprise was last updated.
    updatedBy String
    (String) The IAM ID of the user or service that updated an enterprise.
    url String
    (String) The URL of an enterprise.

    Look up Existing Enterprise Resource

    Get an existing Enterprise 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?: EnterpriseState, opts?: CustomResourceOptions): Enterprise
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        domain: Optional[str] = None,
        enterprise_account_id: Optional[str] = None,
        enterprise_id: Optional[str] = None,
        name: Optional[str] = None,
        primary_contact_email: Optional[str] = None,
        primary_contact_iam_id: Optional[str] = None,
        source_account_id: Optional[str] = None,
        state: Optional[str] = None,
        timeouts: Optional[EnterpriseTimeoutsArgs] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        url: Optional[str] = None) -> Enterprise
    func GetEnterprise(ctx *Context, name string, id IDInput, state *EnterpriseState, opts ...ResourceOption) (*Enterprise, error)
    public static Enterprise Get(string name, Input<string> id, EnterpriseState? state, CustomResourceOptions? opts = null)
    public static Enterprise get(String name, Output<String> id, EnterpriseState state, CustomResourceOptions options)
    resources:  _:    type: ibm:Enterprise    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:
    CreatedAt string
    (Timestamp) The time stamp at which an enterprise is created.
    CreatedBy string
    (String) The IAM ID of an user or service that created an enterprise.
    Crn string
    (String) The Cloud Resource Name (CRN) of an enterprise.
    Domain string
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    EnterpriseId string
    (String) The unique identifier of an enterprise.
    Name string
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    PrimaryContactEmail string
    (String) The Email of the primary contact of an enterprise.
    PrimaryContactIamId string
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    SourceAccountId string
    The ID of an account that is used to create the enterprise.
    State string
    (String) The state of an enterprise.
    Timeouts EnterpriseTimeouts
    UpdatedAt string
    (Timestamp) The time stamp at which an enterprise was last updated.
    UpdatedBy string
    (String) The IAM ID of the user or service that updated an enterprise.
    Url string
    (String) The URL of an enterprise.
    CreatedAt string
    (Timestamp) The time stamp at which an enterprise is created.
    CreatedBy string
    (String) The IAM ID of an user or service that created an enterprise.
    Crn string
    (String) The Cloud Resource Name (CRN) of an enterprise.
    Domain string
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    EnterpriseId string
    (String) The unique identifier of an enterprise.
    Name string
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    PrimaryContactEmail string
    (String) The Email of the primary contact of an enterprise.
    PrimaryContactIamId string
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    SourceAccountId string
    The ID of an account that is used to create the enterprise.
    State string
    (String) The state of an enterprise.
    Timeouts EnterpriseTimeoutsArgs
    UpdatedAt string
    (Timestamp) The time stamp at which an enterprise was last updated.
    UpdatedBy string
    (String) The IAM ID of the user or service that updated an enterprise.
    Url string
    (String) The URL of an enterprise.
    createdAt String
    (Timestamp) The time stamp at which an enterprise is created.
    createdBy String
    (String) The IAM ID of an user or service that created an enterprise.
    crn String
    (String) The Cloud Resource Name (CRN) of an enterprise.
    domain String
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterpriseAccountId String
    (String) The enterprise account ID.
    enterpriseId String
    (String) The unique identifier of an enterprise.
    name String
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    primaryContactEmail String
    (String) The Email of the primary contact of an enterprise.
    primaryContactIamId String
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    sourceAccountId String
    The ID of an account that is used to create the enterprise.
    state String
    (String) The state of an enterprise.
    timeouts EnterpriseTimeouts
    updatedAt String
    (Timestamp) The time stamp at which an enterprise was last updated.
    updatedBy String
    (String) The IAM ID of the user or service that updated an enterprise.
    url String
    (String) The URL of an enterprise.
    createdAt string
    (Timestamp) The time stamp at which an enterprise is created.
    createdBy string
    (String) The IAM ID of an user or service that created an enterprise.
    crn string
    (String) The Cloud Resource Name (CRN) of an enterprise.
    domain string
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterpriseAccountId string
    (String) The enterprise account ID.
    enterpriseId string
    (String) The unique identifier of an enterprise.
    name string
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    primaryContactEmail string
    (String) The Email of the primary contact of an enterprise.
    primaryContactIamId string
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    sourceAccountId string
    The ID of an account that is used to create the enterprise.
    state string
    (String) The state of an enterprise.
    timeouts EnterpriseTimeouts
    updatedAt string
    (Timestamp) The time stamp at which an enterprise was last updated.
    updatedBy string
    (String) The IAM ID of the user or service that updated an enterprise.
    url string
    (String) The URL of an enterprise.
    created_at str
    (Timestamp) The time stamp at which an enterprise is created.
    created_by str
    (String) The IAM ID of an user or service that created an enterprise.
    crn str
    (String) The Cloud Resource Name (CRN) of an enterprise.
    domain str
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterprise_account_id str
    (String) The enterprise account ID.
    enterprise_id str
    (String) The unique identifier of an enterprise.
    name str
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    primary_contact_email str
    (String) The Email of the primary contact of an enterprise.
    primary_contact_iam_id str
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    source_account_id str
    The ID of an account that is used to create the enterprise.
    state str
    (String) The state of an enterprise.
    timeouts EnterpriseTimeoutsArgs
    updated_at str
    (Timestamp) The time stamp at which an enterprise was last updated.
    updated_by str
    (String) The IAM ID of the user or service that updated an enterprise.
    url str
    (String) The URL of an enterprise.
    createdAt String
    (Timestamp) The time stamp at which an enterprise is created.
    createdBy String
    (String) The IAM ID of an user or service that created an enterprise.
    crn String
    (String) The Cloud Resource Name (CRN) of an enterprise.
    domain String
    A domain or subdomain for an enterprise, such as example.com, or my.example.com.
    enterpriseAccountId String
    (String) The enterprise account ID.
    enterpriseId String
    (String) The unique identifier of an enterprise.
    name String
    The name of an enterprise. The minimum and maximum character should be from 3 to 60 characters.
    primaryContactEmail String
    (String) The Email of the primary contact of an enterprise.
    primaryContactIamId String
    The IAM ID of an enterprise primary contact, such as IBMid-0123ABC. The IAM ID must already exist.
    sourceAccountId String
    The ID of an account that is used to create the enterprise.
    state String
    (String) The state of an enterprise.
    timeouts Property Map
    updatedAt String
    (Timestamp) The time stamp at which an enterprise was last updated.
    updatedBy String
    (String) The IAM ID of the user or service that updated an enterprise.
    url String
    (String) The URL of an enterprise.

    Supporting Types

    EnterpriseTimeouts, EnterpriseTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    The ibm_enterprise resource can be imported by using enterprise_id.

    Example

    $ pulumi import ibm:index/enterprise:Enterprise  ibm_enterprise.enterprise_example c117bf3cb7a448fca830645865e3f1f2

    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