1. Packages
  2. Ibm Provider
  3. API Docs
  4. getEnterprises
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getEnterprises

Explore with Pulumi AI

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

    Retrieve an information from an ibm.Enterprise data source. For more information, about enterprise management, see setting up an enterprise.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const enterprises = ibm.getEnterprises({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    enterprises = ibm.get_enterprises()
    
    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.GetEnterprises(ctx, &ibm.GetEnterprisesArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var enterprises = Ibm.GetEnterprises.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetEnterprisesArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var enterprises = IbmFunctions.getEnterprises();
    
        }
    }
    
    variables:
      enterprises:
        fn::invoke:
          function: ibm:getEnterprises
          arguments: {}
    

    Using getEnterprises

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEnterprises(args: GetEnterprisesArgs, opts?: InvokeOptions): Promise<GetEnterprisesResult>
    function getEnterprisesOutput(args: GetEnterprisesOutputArgs, opts?: InvokeOptions): Output<GetEnterprisesResult>
    def get_enterprises(id: Optional[str] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEnterprisesResult
    def get_enterprises_output(id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEnterprisesResult]
    func GetEnterprises(ctx *Context, args *GetEnterprisesArgs, opts ...InvokeOption) (*GetEnterprisesResult, error)
    func GetEnterprisesOutput(ctx *Context, args *GetEnterprisesOutputArgs, opts ...InvokeOption) GetEnterprisesResultOutput

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

    public static class GetEnterprises 
    {
        public static Task<GetEnterprisesResult> InvokeAsync(GetEnterprisesArgs args, InvokeOptions? opts = null)
        public static Output<GetEnterprisesResult> Invoke(GetEnterprisesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEnterprisesResult> getEnterprises(GetEnterprisesArgs args, InvokeOptions options)
    public static Output<GetEnterprisesResult> getEnterprises(GetEnterprisesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getEnterprises:getEnterprises
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The unique identifier of an enterprises.
    Name string
    The name of an enterprise.
    Id string
    (String) The unique identifier of an enterprises.
    Name string
    The name of an enterprise.
    id String
    (String) The unique identifier of an enterprises.
    name String
    The name of an enterprise.
    id string
    (String) The unique identifier of an enterprises.
    name string
    The name of an enterprise.
    id str
    (String) The unique identifier of an enterprises.
    name str
    The name of an enterprise.
    id String
    (String) The unique identifier of an enterprises.
    name String
    The name of an enterprise.

    getEnterprises Result

    The following output properties are available:

    Enterprises List<GetEnterprisesEnterprise>
    (String) A list of enterprise objects. Nested resources blocks has the following structure.
    Id string
    (String) The unique identifier of an enterprises.
    Name string
    (String) The name of an enterprise.
    Enterprises []GetEnterprisesEnterprise
    (String) A list of enterprise objects. Nested resources blocks has the following structure.
    Id string
    (String) The unique identifier of an enterprises.
    Name string
    (String) The name of an enterprise.
    enterprises List<GetEnterprisesEnterprise>
    (String) A list of enterprise objects. Nested resources blocks has the following structure.
    id String
    (String) The unique identifier of an enterprises.
    name String
    (String) The name of an enterprise.
    enterprises GetEnterprisesEnterprise[]
    (String) A list of enterprise objects. Nested resources blocks has the following structure.
    id string
    (String) The unique identifier of an enterprises.
    name string
    (String) The name of an enterprise.
    enterprises Sequence[GetEnterprisesEnterprise]
    (String) A list of enterprise objects. Nested resources blocks has the following structure.
    id str
    (String) The unique identifier of an enterprises.
    name str
    (String) The name of an enterprise.
    enterprises List<Property Map>
    (String) A list of enterprise objects. Nested resources blocks has the following structure.
    id String
    (String) The unique identifier of an enterprises.
    name String
    (String) The name of an enterprise.

    Supporting Types

    GetEnterprisesEnterprise

    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
    (String) The domain of an enterprise.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    Id string
    (String) The unique identifier of an enterprises.
    Name string
    The name of an enterprise.
    PrimaryContactEmail string
    (String) The Email address of the primary contact of an enterprise.
    PrimaryContactIamId string
    (String) The IAM ID of the primary contact of an enterprise, such as IBMid-0123ABC.
    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.
    Domain string
    (String) The domain of an enterprise.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    Id string
    (String) The unique identifier of an enterprises.
    Name string
    The name of an enterprise.
    PrimaryContactEmail string
    (String) The Email address of the primary contact of an enterprise.
    PrimaryContactIamId string
    (String) The IAM ID of the primary contact of an enterprise, such as IBMid-0123ABC.
    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.
    domain String
    (String) The domain of an enterprise.
    enterpriseAccountId String
    (String) The enterprise account ID.
    id String
    (String) The unique identifier of an enterprises.
    name String
    The name of an enterprise.
    primaryContactEmail String
    (String) The Email address of the primary contact of an enterprise.
    primaryContactIamId String
    (String) The IAM ID of the primary contact of an enterprise, such as IBMid-0123ABC.
    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.
    domain string
    (String) The domain of an enterprise.
    enterpriseAccountId string
    (String) The enterprise account ID.
    id string
    (String) The unique identifier of an enterprises.
    name string
    The name of an enterprise.
    primaryContactEmail string
    (String) The Email address of the primary contact of an enterprise.
    primaryContactIamId string
    (String) The IAM ID of the primary contact of an enterprise, such as IBMid-0123ABC.
    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.
    domain str
    (String) The domain of an enterprise.
    enterprise_account_id str
    (String) The enterprise account ID.
    id str
    (String) The unique identifier of an enterprises.
    name str
    The name of an enterprise.
    primary_contact_email str
    (String) The Email address of the primary contact of an enterprise.
    primary_contact_iam_id str
    (String) The IAM ID of the primary contact of an enterprise, such as IBMid-0123ABC.
    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.
    domain String
    (String) The domain of an enterprise.
    enterpriseAccountId String
    (String) The enterprise account ID.
    id String
    (String) The unique identifier of an enterprises.
    name String
    The name of an enterprise.
    primaryContactEmail String
    (String) The Email address of the primary contact of an enterprise.
    primaryContactIamId String
    (String) The IAM ID of the primary contact of an enterprise, such as IBMid-0123ABC.
    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.

    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