1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCmAccount
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getCmAccount

Explore with Pulumi AI

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({});
Copy
import pulumi
import pulumi_ibm as ibm

cm_account = ibm.get_cm_account()
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.LookupCmAccount(ctx, &ibm.LookupCmAccountArgs{}, nil)
		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 cmAccount = Ibm.GetCmAccount.Invoke();

});
Copy
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();

    }
}
Copy
variables:
  cmAccount:
    fn::invoke:
      function: ibm:getCmAccount
      arguments: {}
Copy

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>
Copy
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]
Copy
func LookupCmAccount(ctx *Context, args *LookupCmAccountArgs, opts ...InvokeOption) (*LookupCmAccountResult, error)
func LookupCmAccountOutput(ctx *Context, args *LookupCmAccountOutputArgs, opts ...InvokeOption) LookupCmAccountResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetCmAccountResult> getCmAccount(GetCmAccountArgs args, InvokeOptions options)
public static Output<GetCmAccountResult> getCmAccount(GetCmAccountArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCmAccount:getCmAccount
  arguments:
    # arguments dictionary
Copy

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.
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.
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.
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.
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.
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.

Supporting Types

GetCmAccountAccountFilter

CategoryFilters This property is required. List<GetCmAccountAccountFilterCategoryFilter>
(List) Filter against offering properties. Nested schema for category_filters:
IdFilters This property is required. 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 This property is required. 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 This property is required. []GetCmAccountAccountFilterCategoryFilter
(List) Filter against offering properties. Nested schema for category_filters:
IdFilters This property is required. []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 This property is required. 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 This property is required. List<GetCmAccountAccountFilterCategoryFilter>
(List) Filter against offering properties. Nested schema for category_filters:
idFilters This property is required. 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 This property is required. 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 This property is required. GetCmAccountAccountFilterCategoryFilter[]
(List) Filter against offering properties. Nested schema for category_filters:
idFilters This property is required. 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 This property is required. 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 This property is required. Sequence[GetCmAccountAccountFilterCategoryFilter]
(List) Filter against offering properties. Nested schema for category_filters:
id_filters This property is required. 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 This property is required. 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 This property is required. List<Property Map>
(List) Filter against offering properties. Nested schema for category_filters:
idFilters This property is required. 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 This property is required. 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 This property is required. string
(String) Name of the category.
Filters This property is required. List<GetCmAccountAccountFilterCategoryFilterFilter>
(List) Filter terms related to the category. Nested schema for filter:
Include This property is required. bool
(List) Offering filter terms. Nested schema for include:
CategoryName This property is required. string
(String) Name of the category.
Filters This property is required. []GetCmAccountAccountFilterCategoryFilterFilter
(List) Filter terms related to the category. Nested schema for filter:
Include This property is required. bool
(List) Offering filter terms. Nested schema for include:
categoryName This property is required. String
(String) Name of the category.
filters This property is required. List<GetCmAccountAccountFilterCategoryFilterFilter>
(List) Filter terms related to the category. Nested schema for filter:
include This property is required. Boolean
(List) Offering filter terms. Nested schema for include:
categoryName This property is required. string
(String) Name of the category.
filters This property is required. GetCmAccountAccountFilterCategoryFilterFilter[]
(List) Filter terms related to the category. Nested schema for filter:
include This property is required. boolean
(List) Offering filter terms. Nested schema for include:
category_name This property is required. str
(String) Name of the category.
filters This property is required. Sequence[GetCmAccountAccountFilterCategoryFilterFilter]
(List) Filter terms related to the category. Nested schema for filter:
include This property is required. bool
(List) Offering filter terms. Nested schema for include:
categoryName This property is required. String
(String) Name of the category.
filters This property is required. List<Property Map>
(List) Filter terms related to the category. Nested schema for filter:
include This property is required. Boolean
(List) Offering filter terms. Nested schema for include:

GetCmAccountAccountFilterCategoryFilterFilter

FilterTerms This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<GetCmAccountAccountFilterIdFilterExclude>
(List) Offering filter terms. Nested schema for exclude:
Includes This property is required. List<GetCmAccountAccountFilterIdFilterInclude>
(List) Offering filter terms. Nested schema for include:
Excludes This property is required. []GetCmAccountAccountFilterIdFilterExclude
(List) Offering filter terms. Nested schema for exclude:
Includes This property is required. []GetCmAccountAccountFilterIdFilterInclude
(List) Offering filter terms. Nested schema for include:
excludes This property is required. List<GetCmAccountAccountFilterIdFilterExclude>
(List) Offering filter terms. Nested schema for exclude:
includes This property is required. List<GetCmAccountAccountFilterIdFilterInclude>
(List) Offering filter terms. Nested schema for include:
excludes This property is required. GetCmAccountAccountFilterIdFilterExclude[]
(List) Offering filter terms. Nested schema for exclude:
includes This property is required. GetCmAccountAccountFilterIdFilterInclude[]
(List) Offering filter terms. Nested schema for include:
excludes This property is required. Sequence[GetCmAccountAccountFilterIdFilterExclude]
(List) Offering filter terms. Nested schema for exclude:
includes This property is required. Sequence[GetCmAccountAccountFilterIdFilterInclude]
(List) Offering filter terms. Nested schema for include:
excludes This property is required. List<Property Map>
(List) Offering filter terms. Nested schema for exclude:
includes This property is required. List<Property Map>
(List) Offering filter terms. Nested schema for include:

GetCmAccountAccountFilterIdFilterExclude

FilterTerms This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.