1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCmAccount
ibm 1.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud

ibm.getCmAccount

Explore with Pulumi AI

ibm logo
ibm 1.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud

    Provides a read-only data source to retrieve information about a cm_account. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const cmAccount = ibm.getCmAccount({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    cm_account = ibm.get_cm_account()
    
    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.LookupCmAccount(ctx, &ibm.LookupCmAccountArgs{}, 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 cmAccount = Ibm.GetCmAccount.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.GetCmAccountArgs;
    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 cmAccount = IbmFunctions.getCmAccount();
    
        }
    }
    
    variables:
      cmAccount:
        fn::invoke:
          function: ibm:getCmAccount
          arguments: {}
    

    Using getCmAccount

    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 getCmAccount(args: GetCmAccountArgs, opts?: InvokeOptions): Promise<GetCmAccountResult>
    function getCmAccountOutput(args: GetCmAccountOutputArgs, opts?: InvokeOptions): Output<GetCmAccountResult>
    def get_cm_account(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCmAccountResult
    def get_cm_account_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCmAccountResult]
    func LookupCmAccount(ctx *Context, args *LookupCmAccountArgs, opts ...InvokeOption) (*LookupCmAccountResult, error)
    func LookupCmAccountOutput(ctx *Context, args *LookupCmAccountOutputArgs, opts ...InvokeOption) LookupCmAccountResultOutput

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

    public static class GetCmAccount 
    {
        public static Task<GetCmAccountResult> InvokeAsync(GetCmAccountArgs args, InvokeOptions? opts = null)
        public static Output<GetCmAccountResult> Invoke(GetCmAccountInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCmAccountResult> getCmAccount(GetCmAccountArgs args, InvokeOptions options)
    public static Output<GetCmAccountResult> getCmAccount(GetCmAccountArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getCmAccount:getCmAccount
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The unique identifier of the cm_account.
    Id string
    The unique identifier of the cm_account.
    id String
    The unique identifier of the cm_account.
    id string
    The unique identifier of the cm_account.
    id str
    The unique identifier of the cm_account.
    id String
    The unique identifier of the cm_account.

    getCmAccount Result

    The following output properties are available:

    AccountFilters List<GetCmAccountAccountFilter>
    (List) Filters for account and catalog filters. Nested schema for account_filters:
    HideIbmCloudCatalog bool
    (Boolean) Hide the public catalog in this account.
    Id string
    The unique identifier of the cm_account.
    RegionFilter string
    (String) Region filter string.
    Rev string
    (String) Cloudant revision.
    TerraformEngines List<GetCmAccountTerraformEngine>
    AccountFilters []GetCmAccountAccountFilter
    (List) Filters for account and catalog filters. Nested schema for account_filters:
    HideIbmCloudCatalog bool
    (Boolean) Hide the public catalog in this account.
    Id string
    The unique identifier of the cm_account.
    RegionFilter string
    (String) Region filter string.
    Rev string
    (String) Cloudant revision.
    TerraformEngines []GetCmAccountTerraformEngine
    accountFilters List<GetCmAccountAccountFilter>
    (List) Filters for account and catalog filters. Nested schema for account_filters:
    hideIbmCloudCatalog Boolean
    (Boolean) Hide the public catalog in this account.
    id String
    The unique identifier of the cm_account.
    regionFilter String
    (String) Region filter string.
    rev String
    (String) Cloudant revision.
    terraformEngines List<GetCmAccountTerraformEngine>
    accountFilters GetCmAccountAccountFilter[]
    (List) Filters for account and catalog filters. Nested schema for account_filters:
    hideIbmCloudCatalog boolean
    (Boolean) Hide the public catalog in this account.
    id string
    The unique identifier of the cm_account.
    regionFilter string
    (String) Region filter string.
    rev string
    (String) Cloudant revision.
    terraformEngines GetCmAccountTerraformEngine[]
    account_filters Sequence[GetCmAccountAccountFilter]
    (List) Filters for account and catalog filters. Nested schema for account_filters:
    hide_ibm_cloud_catalog bool
    (Boolean) Hide the public catalog in this account.
    id str
    The unique identifier of the cm_account.
    region_filter str
    (String) Region filter string.
    rev str
    (String) Cloudant revision.
    terraform_engines Sequence[GetCmAccountTerraformEngine]
    accountFilters List<Property Map>
    (List) Filters for account and catalog filters. Nested schema for account_filters:
    hideIbmCloudCatalog Boolean
    (Boolean) Hide the public catalog in this account.
    id String
    The unique identifier of the cm_account.
    regionFilter String
    (String) Region filter string.
    rev String
    (String) Cloudant revision.
    terraformEngines List<Property Map>

    Supporting Types

    GetCmAccountAccountFilter

    CategoryFilters List<GetCmAccountAccountFilterCategoryFilter>
    (List) Filter against offering properties. Nested schema for category_filters:
    IdFilters List<GetCmAccountAccountFilterIdFilter>
    (List) Filter on offering ID's. There is an include filter and an exclule filter. Both can be set. Nested schema for id_filters:
    IncludeAll bool
    (Boolean) > true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.
    CategoryFilters []GetCmAccountAccountFilterCategoryFilter
    (List) Filter against offering properties. Nested schema for category_filters:
    IdFilters []GetCmAccountAccountFilterIdFilter
    (List) Filter on offering ID's. There is an include filter and an exclule filter. Both can be set. Nested schema for id_filters:
    IncludeAll bool
    (Boolean) > true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.
    categoryFilters List<GetCmAccountAccountFilterCategoryFilter>
    (List) Filter against offering properties. Nested schema for category_filters:
    idFilters List<GetCmAccountAccountFilterIdFilter>
    (List) Filter on offering ID's. There is an include filter and an exclule filter. Both can be set. Nested schema for id_filters:
    includeAll Boolean
    (Boolean) > true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.
    categoryFilters GetCmAccountAccountFilterCategoryFilter[]
    (List) Filter against offering properties. Nested schema for category_filters:
    idFilters GetCmAccountAccountFilterIdFilter[]
    (List) Filter on offering ID's. There is an include filter and an exclule filter. Both can be set. Nested schema for id_filters:
    includeAll boolean
    (Boolean) > true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.
    category_filters Sequence[GetCmAccountAccountFilterCategoryFilter]
    (List) Filter against offering properties. Nested schema for category_filters:
    id_filters Sequence[GetCmAccountAccountFilterIdFilter]
    (List) Filter on offering ID's. There is an include filter and an exclule filter. Both can be set. Nested schema for id_filters:
    include_all bool
    (Boolean) > true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.
    categoryFilters List<Property Map>
    (List) Filter against offering properties. Nested schema for category_filters:
    idFilters List<Property Map>
    (List) Filter on offering ID's. There is an include filter and an exclule filter. Both can be set. Nested schema for id_filters:
    includeAll Boolean
    (Boolean) > true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.

    GetCmAccountAccountFilterCategoryFilter

    CategoryName string
    (String) Name of the category.
    Filters List<GetCmAccountAccountFilterCategoryFilterFilter>
    (List) Filter terms related to the category. Nested schema for filter:
    Include bool
    (List) Offering filter terms. Nested schema for include:
    CategoryName string
    (String) Name of the category.
    Filters []GetCmAccountAccountFilterCategoryFilterFilter
    (List) Filter terms related to the category. Nested schema for filter:
    Include bool
    (List) Offering filter terms. Nested schema for include:
    categoryName String
    (String) Name of the category.
    filters List<GetCmAccountAccountFilterCategoryFilterFilter>
    (List) Filter terms related to the category. Nested schema for filter:
    include Boolean
    (List) Offering filter terms. Nested schema for include:
    categoryName string
    (String) Name of the category.
    filters GetCmAccountAccountFilterCategoryFilterFilter[]
    (List) Filter terms related to the category. Nested schema for filter:
    include boolean
    (List) Offering filter terms. Nested schema for include:
    category_name str
    (String) Name of the category.
    filters Sequence[GetCmAccountAccountFilterCategoryFilterFilter]
    (List) Filter terms related to the category. Nested schema for filter:
    include bool
    (List) Offering filter terms. Nested schema for include:
    categoryName String
    (String) Name of the category.
    filters List<Property Map>
    (List) Filter terms related to the category. Nested schema for filter:
    include Boolean
    (List) Offering filter terms. Nested schema for include:

    GetCmAccountAccountFilterCategoryFilterFilter

    FilterTerms List<string>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    FilterTerms []string
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms List<String>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms string[]
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filter_terms Sequence[str]
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms List<String>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.

    GetCmAccountAccountFilterIdFilter

    Excludes List<GetCmAccountAccountFilterIdFilterExclude>
    (List) Offering filter terms. Nested schema for exclude:
    Includes List<GetCmAccountAccountFilterIdFilterInclude>
    (List) Offering filter terms. Nested schema for include:
    Excludes []GetCmAccountAccountFilterIdFilterExclude
    (List) Offering filter terms. Nested schema for exclude:
    Includes []GetCmAccountAccountFilterIdFilterInclude
    (List) Offering filter terms. Nested schema for include:
    excludes List<GetCmAccountAccountFilterIdFilterExclude>
    (List) Offering filter terms. Nested schema for exclude:
    includes List<GetCmAccountAccountFilterIdFilterInclude>
    (List) Offering filter terms. Nested schema for include:
    excludes GetCmAccountAccountFilterIdFilterExclude[]
    (List) Offering filter terms. Nested schema for exclude:
    includes GetCmAccountAccountFilterIdFilterInclude[]
    (List) Offering filter terms. Nested schema for include:
    excludes Sequence[GetCmAccountAccountFilterIdFilterExclude]
    (List) Offering filter terms. Nested schema for exclude:
    includes Sequence[GetCmAccountAccountFilterIdFilterInclude]
    (List) Offering filter terms. Nested schema for include:
    excludes List<Property Map>
    (List) Offering filter terms. Nested schema for exclude:
    includes List<Property Map>
    (List) Offering filter terms. Nested schema for include:

    GetCmAccountAccountFilterIdFilterExclude

    FilterTerms List<string>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    FilterTerms []string
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms List<String>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms string[]
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filter_terms Sequence[str]
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms List<String>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.

    GetCmAccountAccountFilterIdFilterInclude

    FilterTerms List<string>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    FilterTerms []string
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms List<String>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms string[]
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filter_terms Sequence[str]
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.
    filterTerms List<String>
    (List) List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.

    GetCmAccountTerraformEngine

    ApiToken string
    (String) The api key used to access the engine instance.
    DaCreations List<GetCmAccountTerraformEngineDaCreation>
    Name string
    (String) User provided name for the specified engine.
    PrivateEndpoint string
    (String) The private endpoint for the engine instance.
    PublicEndpoint string
    (String) The public endpoint for the engine instance.
    Type string
    ApiToken string
    (String) The api key used to access the engine instance.
    DaCreations []GetCmAccountTerraformEngineDaCreation
    Name string
    (String) User provided name for the specified engine.
    PrivateEndpoint string
    (String) The private endpoint for the engine instance.
    PublicEndpoint string
    (String) The public endpoint for the engine instance.
    Type string
    apiToken String
    (String) The api key used to access the engine instance.
    daCreations List<GetCmAccountTerraformEngineDaCreation>
    name String
    (String) User provided name for the specified engine.
    privateEndpoint String
    (String) The private endpoint for the engine instance.
    publicEndpoint String
    (String) The public endpoint for the engine instance.
    type String
    apiToken string
    (String) The api key used to access the engine instance.
    daCreations GetCmAccountTerraformEngineDaCreation[]
    name string
    (String) User provided name for the specified engine.
    privateEndpoint string
    (String) The private endpoint for the engine instance.
    publicEndpoint string
    (String) The public endpoint for the engine instance.
    type string
    api_token str
    (String) The api key used to access the engine instance.
    da_creations Sequence[GetCmAccountTerraformEngineDaCreation]
    name str
    (String) User provided name for the specified engine.
    private_endpoint str
    (String) The private endpoint for the engine instance.
    public_endpoint str
    (String) The public endpoint for the engine instance.
    type str
    apiToken String
    (String) The api key used to access the engine instance.
    daCreations List<Property Map>
    name String
    (String) User provided name for the specified engine.
    privateEndpoint String
    (String) The private endpoint for the engine instance.
    publicEndpoint String
    (String) The public endpoint for the engine instance.
    type String

    GetCmAccountTerraformEngineDaCreation

    DefaultPrivateCatalogId string
    (String) Default private catalog to create the deployable architectures in.
    Enabled bool
    (Boolean) Determines whether deployable architectures are auto-created from workspaces in the engine.
    PollingInfos List<GetCmAccountTerraformEngineDaCreationPollingInfo>
    (List) Determines which workspace scope to query to auto-create deployable architectures from. Nested schema for polling_info:
    DefaultPrivateCatalogId string
    (String) Default private catalog to create the deployable architectures in.
    Enabled bool
    (Boolean) Determines whether deployable architectures are auto-created from workspaces in the engine.
    PollingInfos []GetCmAccountTerraformEngineDaCreationPollingInfo
    (List) Determines which workspace scope to query to auto-create deployable architectures from. Nested schema for polling_info:
    defaultPrivateCatalogId String
    (String) Default private catalog to create the deployable architectures in.
    enabled Boolean
    (Boolean) Determines whether deployable architectures are auto-created from workspaces in the engine.
    pollingInfos List<GetCmAccountTerraformEngineDaCreationPollingInfo>
    (List) Determines which workspace scope to query to auto-create deployable architectures from. Nested schema for polling_info:
    defaultPrivateCatalogId string
    (String) Default private catalog to create the deployable architectures in.
    enabled boolean
    (Boolean) Determines whether deployable architectures are auto-created from workspaces in the engine.
    pollingInfos GetCmAccountTerraformEngineDaCreationPollingInfo[]
    (List) Determines which workspace scope to query to auto-create deployable architectures from. Nested schema for polling_info:
    default_private_catalog_id str
    (String) Default private catalog to create the deployable architectures in.
    enabled bool
    (Boolean) Determines whether deployable architectures are auto-created from workspaces in the engine.
    polling_infos Sequence[GetCmAccountTerraformEngineDaCreationPollingInfo]
    (List) Determines which workspace scope to query to auto-create deployable architectures from. Nested schema for polling_info:
    defaultPrivateCatalogId String
    (String) Default private catalog to create the deployable architectures in.
    enabled Boolean
    (Boolean) Determines whether deployable architectures are auto-created from workspaces in the engine.
    pollingInfos List<Property Map>
    (List) Determines which workspace scope to query to auto-create deployable architectures from. Nested schema for polling_info:

    GetCmAccountTerraformEngineDaCreationPollingInfo

    LastPollingStatuses List<GetCmAccountTerraformEngineDaCreationPollingInfoLastPollingStatus>
    (List) Last polling status of the engine scope. Nested schema for last_polling_status:
    Scopes List<GetCmAccountTerraformEngineDaCreationPollingInfoScope>
    (List) List of scopes to auto-create deployable architectures from workspaces in the engine. Nested schema for scopes:
    LastPollingStatuses []GetCmAccountTerraformEngineDaCreationPollingInfoLastPollingStatus
    (List) Last polling status of the engine scope. Nested schema for last_polling_status:
    Scopes []GetCmAccountTerraformEngineDaCreationPollingInfoScope
    (List) List of scopes to auto-create deployable architectures from workspaces in the engine. Nested schema for scopes:
    lastPollingStatuses List<GetCmAccountTerraformEngineDaCreationPollingInfoLastPollingStatus>
    (List) Last polling status of the engine scope. Nested schema for last_polling_status:
    scopes List<GetCmAccountTerraformEngineDaCreationPollingInfoScope>
    (List) List of scopes to auto-create deployable architectures from workspaces in the engine. Nested schema for scopes:
    lastPollingStatuses GetCmAccountTerraformEngineDaCreationPollingInfoLastPollingStatus[]
    (List) Last polling status of the engine scope. Nested schema for last_polling_status:
    scopes GetCmAccountTerraformEngineDaCreationPollingInfoScope[]
    (List) List of scopes to auto-create deployable architectures from workspaces in the engine. Nested schema for scopes:
    last_polling_statuses Sequence[GetCmAccountTerraformEngineDaCreationPollingInfoLastPollingStatus]
    (List) Last polling status of the engine scope. Nested schema for last_polling_status:
    scopes Sequence[GetCmAccountTerraformEngineDaCreationPollingInfoScope]
    (List) List of scopes to auto-create deployable architectures from workspaces in the engine. Nested schema for scopes:
    lastPollingStatuses List<Property Map>
    (List) Last polling status of the engine scope. Nested schema for last_polling_status:
    scopes List<Property Map>
    (List) List of scopes to auto-create deployable architectures from workspaces in the engine. Nested schema for scopes:

    GetCmAccountTerraformEngineDaCreationPollingInfoLastPollingStatus

    Code double
    (Integer) Status code of the last polling attempt.
    Message string
    (String) Status message from the last polling attempt.
    Code float64
    (Integer) Status code of the last polling attempt.
    Message string
    (String) Status message from the last polling attempt.
    code Double
    (Integer) Status code of the last polling attempt.
    message String
    (String) Status message from the last polling attempt.
    code number
    (Integer) Status code of the last polling attempt.
    message string
    (String) Status message from the last polling attempt.
    code float
    (Integer) Status code of the last polling attempt.
    message str
    (String) Status message from the last polling attempt.
    code Number
    (Integer) Status code of the last polling attempt.
    message String
    (String) Status message from the last polling attempt.

    GetCmAccountTerraformEngineDaCreationPollingInfoScope

    Name string
    (String) User provided name for the specified engine.
    Type string
    Name string
    (String) User provided name for the specified engine.
    Type string
    name String
    (String) User provided name for the specified engine.
    type String
    name string
    (String) User provided name for the specified engine.
    type string
    name str
    (String) User provided name for the specified engine.
    type str
    name String
    (String) User provided name for the specified engine.
    type String

    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.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud