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

ibm.getEnterpriseAccountGroups

Explore with Pulumi AI

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

    Retrieve an information from an account_groups data source. For more information, about enterprise account groups, refer to setting up access groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const accountGroups = ibm.getEnterpriseAccountGroups({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    account_groups = ibm.get_enterprise_account_groups()
    
    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.GetEnterpriseAccountGroups(ctx, &ibm.GetEnterpriseAccountGroupsArgs{}, 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 accountGroups = Ibm.GetEnterpriseAccountGroups.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.GetEnterpriseAccountGroupsArgs;
    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 accountGroups = IbmFunctions.getEnterpriseAccountGroups();
    
        }
    }
    
    variables:
      accountGroups:
        fn::invoke:
          function: ibm:getEnterpriseAccountGroups
          arguments: {}
    

    Using getEnterpriseAccountGroups

    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 getEnterpriseAccountGroups(args: GetEnterpriseAccountGroupsArgs, opts?: InvokeOptions): Promise<GetEnterpriseAccountGroupsResult>
    function getEnterpriseAccountGroupsOutput(args: GetEnterpriseAccountGroupsOutputArgs, opts?: InvokeOptions): Output<GetEnterpriseAccountGroupsResult>
    def get_enterprise_account_groups(id: Optional[str] = None,
                                      name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetEnterpriseAccountGroupsResult
    def get_enterprise_account_groups_output(id: Optional[pulumi.Input[str]] = None,
                                      name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetEnterpriseAccountGroupsResult]
    func GetEnterpriseAccountGroups(ctx *Context, args *GetEnterpriseAccountGroupsArgs, opts ...InvokeOption) (*GetEnterpriseAccountGroupsResult, error)
    func GetEnterpriseAccountGroupsOutput(ctx *Context, args *GetEnterpriseAccountGroupsOutputArgs, opts ...InvokeOption) GetEnterpriseAccountGroupsResultOutput

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

    public static class GetEnterpriseAccountGroups 
    {
        public static Task<GetEnterpriseAccountGroupsResult> InvokeAsync(GetEnterpriseAccountGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetEnterpriseAccountGroupsResult> Invoke(GetEnterpriseAccountGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEnterpriseAccountGroupsResult> getEnterpriseAccountGroups(GetEnterpriseAccountGroupsArgs args, InvokeOptions options)
    public static Output<GetEnterpriseAccountGroupsResult> getEnterpriseAccountGroups(GetEnterpriseAccountGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getEnterpriseAccountGroups:getEnterpriseAccountGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The account group ID.
    Name string
    The name of an account group.
    Id string
    (String) The account group ID.
    Name string
    The name of an account group.
    id String
    (String) The account group ID.
    name String
    The name of an account group.
    id string
    (String) The account group ID.
    name string
    The name of an account group.
    id str
    (String) The account group ID.
    name str
    The name of an account group.
    id String
    (String) The account group ID.
    name String
    The name of an account group.

    getEnterpriseAccountGroups Result

    The following output properties are available:

    AccountGroups List<GetEnterpriseAccountGroupsAccountGroup>
    (List) A list of account groups. Nested resources blocks has the following structure.
    Id string
    (String) The account group ID.
    Name string
    (String) The name of an account group.
    AccountGroups []GetEnterpriseAccountGroupsAccountGroup
    (List) A list of account groups. Nested resources blocks has the following structure.
    Id string
    (String) The account group ID.
    Name string
    (String) The name of an account group.
    accountGroups List<GetEnterpriseAccountGroupsAccountGroup>
    (List) A list of account groups. Nested resources blocks has the following structure.
    id String
    (String) The account group ID.
    name String
    (String) The name of an account group.
    accountGroups GetEnterpriseAccountGroupsAccountGroup[]
    (List) A list of account groups. Nested resources blocks has the following structure.
    id string
    (String) The account group ID.
    name string
    (String) The name of an account group.
    account_groups Sequence[GetEnterpriseAccountGroupsAccountGroup]
    (List) A list of account groups. Nested resources blocks has the following structure.
    id str
    (String) The account group ID.
    name str
    (String) The name of an account group.
    accountGroups List<Property Map>
    (List) A list of account groups. Nested resources blocks has the following structure.
    id String
    (String) The account group ID.
    name String
    (String) The name of an account group.

    Supporting Types

    GetEnterpriseAccountGroupsAccountGroup

    CreatedAt string
    (Timestamp) The time stamp at which an account is created.
    CreatedBy string
    (String) The IAM ID of an user or service that created an account group.
    Crn string
    (String) The Cloud Resource Name (CRN) of an account group.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    EnterpriseId string
    (String) The enterprise ID that an account group is a part of.
    EnterprisePath string
    (String) The path from an enterprise to the particular account group.
    Id string
    (String) The account group ID.
    Name string
    The name of an account group.
    Parent string
    (String) The CRN of the parent of an account group.
    PrimaryContactEmail string
    (String) The Email address of the owner of an account group.
    PrimaryContactIamId string
    (String) The IAM ID of the owner of an account group.
    State string
    (String) The state of an account group.
    UpdatedAt string
    (Timestamp) The time stamp at which an account was last updated.
    UpdatedBy string
    (String) The IAM ID of the user or service that updated an account group.
    Url string
    (String) The URL of an account group.
    CreatedAt string
    (Timestamp) The time stamp at which an account is created.
    CreatedBy string
    (String) The IAM ID of an user or service that created an account group.
    Crn string
    (String) The Cloud Resource Name (CRN) of an account group.
    EnterpriseAccountId string
    (String) The enterprise account ID.
    EnterpriseId string
    (String) The enterprise ID that an account group is a part of.
    EnterprisePath string
    (String) The path from an enterprise to the particular account group.
    Id string
    (String) The account group ID.
    Name string
    The name of an account group.
    Parent string
    (String) The CRN of the parent of an account group.
    PrimaryContactEmail string
    (String) The Email address of the owner of an account group.
    PrimaryContactIamId string
    (String) The IAM ID of the owner of an account group.
    State string
    (String) The state of an account group.
    UpdatedAt string
    (Timestamp) The time stamp at which an account was last updated.
    UpdatedBy string
    (String) The IAM ID of the user or service that updated an account group.
    Url string
    (String) The URL of an account group.
    createdAt String
    (Timestamp) The time stamp at which an account is created.
    createdBy String
    (String) The IAM ID of an user or service that created an account group.
    crn String
    (String) The Cloud Resource Name (CRN) of an account group.
    enterpriseAccountId String
    (String) The enterprise account ID.
    enterpriseId String
    (String) The enterprise ID that an account group is a part of.
    enterprisePath String
    (String) The path from an enterprise to the particular account group.
    id String
    (String) The account group ID.
    name String
    The name of an account group.
    parent String
    (String) The CRN of the parent of an account group.
    primaryContactEmail String
    (String) The Email address of the owner of an account group.
    primaryContactIamId String
    (String) The IAM ID of the owner of an account group.
    state String
    (String) The state of an account group.
    updatedAt String
    (Timestamp) The time stamp at which an account was last updated.
    updatedBy String
    (String) The IAM ID of the user or service that updated an account group.
    url String
    (String) The URL of an account group.
    createdAt string
    (Timestamp) The time stamp at which an account is created.
    createdBy string
    (String) The IAM ID of an user or service that created an account group.
    crn string
    (String) The Cloud Resource Name (CRN) of an account group.
    enterpriseAccountId string
    (String) The enterprise account ID.
    enterpriseId string
    (String) The enterprise ID that an account group is a part of.
    enterprisePath string
    (String) The path from an enterprise to the particular account group.
    id string
    (String) The account group ID.
    name string
    The name of an account group.
    parent string
    (String) The CRN of the parent of an account group.
    primaryContactEmail string
    (String) The Email address of the owner of an account group.
    primaryContactIamId string
    (String) The IAM ID of the owner of an account group.
    state string
    (String) The state of an account group.
    updatedAt string
    (Timestamp) The time stamp at which an account was last updated.
    updatedBy string
    (String) The IAM ID of the user or service that updated an account group.
    url string
    (String) The URL of an account group.
    created_at str
    (Timestamp) The time stamp at which an account is created.
    created_by str
    (String) The IAM ID of an user or service that created an account group.
    crn str
    (String) The Cloud Resource Name (CRN) of an account group.
    enterprise_account_id str
    (String) The enterprise account ID.
    enterprise_id str
    (String) The enterprise ID that an account group is a part of.
    enterprise_path str
    (String) The path from an enterprise to the particular account group.
    id str
    (String) The account group ID.
    name str
    The name of an account group.
    parent str
    (String) The CRN of the parent of an account group.
    primary_contact_email str
    (String) The Email address of the owner of an account group.
    primary_contact_iam_id str
    (String) The IAM ID of the owner of an account group.
    state str
    (String) The state of an account group.
    updated_at str
    (Timestamp) The time stamp at which an account was last updated.
    updated_by str
    (String) The IAM ID of the user or service that updated an account group.
    url str
    (String) The URL of an account group.
    createdAt String
    (Timestamp) The time stamp at which an account is created.
    createdBy String
    (String) The IAM ID of an user or service that created an account group.
    crn String
    (String) The Cloud Resource Name (CRN) of an account group.
    enterpriseAccountId String
    (String) The enterprise account ID.
    enterpriseId String
    (String) The enterprise ID that an account group is a part of.
    enterprisePath String
    (String) The path from an enterprise to the particular account group.
    id String
    (String) The account group ID.
    name String
    The name of an account group.
    parent String
    (String) The CRN of the parent of an account group.
    primaryContactEmail String
    (String) The Email address of the owner of an account group.
    primaryContactIamId String
    (String) The IAM ID of the owner of an account group.
    state String
    (String) The state of an account group.
    updatedAt String
    (Timestamp) The time stamp at which an account was last updated.
    updatedBy String
    (String) The IAM ID of the user or service that updated an account group.
    url String
    (String) The URL of an account group.

    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