1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CapacityManagement
  5. getOccCustomerGroup
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.CapacityManagement.getOccCustomerGroup

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

This data source provides details about a specific Occ Customer Group resource in Oracle Cloud Infrastructure Capacity Management service.

Gets information about the specified customer group.

Example Usage

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

const testOccCustomerGroup = oci.CapacityManagement.getOccCustomerGroup({
    occCustomerGroupId: testOccCustomerGroupOciCapacityManagementOccCustomerGroup.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_occ_customer_group = oci.CapacityManagement.get_occ_customer_group(occ_customer_group_id=test_occ_customer_group_oci_capacity_management_occ_customer_group["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/capacitymanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := capacitymanagement.GetOccCustomerGroup(ctx, &capacitymanagement.GetOccCustomerGroupArgs{
			OccCustomerGroupId: testOccCustomerGroupOciCapacityManagementOccCustomerGroup.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testOccCustomerGroup = Oci.CapacityManagement.GetOccCustomerGroup.Invoke(new()
    {
        OccCustomerGroupId = testOccCustomerGroupOciCapacityManagementOccCustomerGroup.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CapacityManagement.CapacityManagementFunctions;
import com.pulumi.oci.CapacityManagement.inputs.GetOccCustomerGroupArgs;
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 testOccCustomerGroup = CapacityManagementFunctions.getOccCustomerGroup(GetOccCustomerGroupArgs.builder()
            .occCustomerGroupId(testOccCustomerGroupOciCapacityManagementOccCustomerGroup.id())
            .build());

    }
}
Copy
variables:
  testOccCustomerGroup:
    fn::invoke:
      function: oci:CapacityManagement:getOccCustomerGroup
      arguments:
        occCustomerGroupId: ${testOccCustomerGroupOciCapacityManagementOccCustomerGroup.id}
Copy

Using getOccCustomerGroup

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 getOccCustomerGroup(args: GetOccCustomerGroupArgs, opts?: InvokeOptions): Promise<GetOccCustomerGroupResult>
function getOccCustomerGroupOutput(args: GetOccCustomerGroupOutputArgs, opts?: InvokeOptions): Output<GetOccCustomerGroupResult>
Copy
def get_occ_customer_group(occ_customer_group_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetOccCustomerGroupResult
def get_occ_customer_group_output(occ_customer_group_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetOccCustomerGroupResult]
Copy
func GetOccCustomerGroup(ctx *Context, args *GetOccCustomerGroupArgs, opts ...InvokeOption) (*GetOccCustomerGroupResult, error)
func GetOccCustomerGroupOutput(ctx *Context, args *GetOccCustomerGroupOutputArgs, opts ...InvokeOption) GetOccCustomerGroupResultOutput
Copy

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

public static class GetOccCustomerGroup 
{
    public static Task<GetOccCustomerGroupResult> InvokeAsync(GetOccCustomerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetOccCustomerGroupResult> Invoke(GetOccCustomerGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOccCustomerGroupResult> getOccCustomerGroup(GetOccCustomerGroupArgs args, InvokeOptions options)
public static Output<GetOccCustomerGroupResult> getOccCustomerGroup(GetOccCustomerGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:CapacityManagement/getOccCustomerGroup:getOccCustomerGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OccCustomerGroupId This property is required. string
The OCID of the customer group.
OccCustomerGroupId This property is required. string
The OCID of the customer group.
occCustomerGroupId This property is required. String
The OCID of the customer group.
occCustomerGroupId This property is required. string
The OCID of the customer group.
occ_customer_group_id This property is required. str
The OCID of the customer group.
occCustomerGroupId This property is required. String
The OCID of the customer group.

getOccCustomerGroup Result

The following output properties are available:

CompartmentId string
The OCID of the tenancy containing the customer group.
CustomersLists List<GetOccCustomerGroupCustomersList>
A list containing all the customers that belong to this customer group
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
The description about the customer group.
DisplayName string
The display name of the customer group.
FreeformTags Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string
The OCID of the customer group.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
OccCustomerGroupId string
The OCID of the customer group.
State string
The current lifecycle state of the resource.
Status string
To determine whether the customer group is enabled/disabled.
SystemTags Dictionary<string, string>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time when the customer group was created.
TimeUpdated string
The time when the customer group was last updated.
CompartmentId string
The OCID of the tenancy containing the customer group.
CustomersLists []GetOccCustomerGroupCustomersList
A list containing all the customers that belong to this customer group
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
The description about the customer group.
DisplayName string
The display name of the customer group.
FreeformTags map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string
The OCID of the customer group.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
OccCustomerGroupId string
The OCID of the customer group.
State string
The current lifecycle state of the resource.
Status string
To determine whether the customer group is enabled/disabled.
SystemTags map[string]string
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time when the customer group was created.
TimeUpdated string
The time when the customer group was last updated.
compartmentId String
The OCID of the tenancy containing the customer group.
customersLists List<GetOccCustomerGroupCustomersList>
A list containing all the customers that belong to this customer group
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
The description about the customer group.
displayName String
The display name of the customer group.
freeformTags Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String
The OCID of the customer group.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
occCustomerGroupId String
The OCID of the customer group.
state String
The current lifecycle state of the resource.
status String
To determine whether the customer group is enabled/disabled.
systemTags Map<String,String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time when the customer group was created.
timeUpdated String
The time when the customer group was last updated.
compartmentId string
The OCID of the tenancy containing the customer group.
customersLists GetOccCustomerGroupCustomersList[]
A list containing all the customers that belong to this customer group
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string
The description about the customer group.
displayName string
The display name of the customer group.
freeformTags {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string
The OCID of the customer group.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
occCustomerGroupId string
The OCID of the customer group.
state string
The current lifecycle state of the resource.
status string
To determine whether the customer group is enabled/disabled.
systemTags {[key: string]: string}
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The time when the customer group was created.
timeUpdated string
The time when the customer group was last updated.
compartment_id str
The OCID of the tenancy containing the customer group.
customers_lists Sequence[capacitymanagement.GetOccCustomerGroupCustomersList]
A list containing all the customers that belong to this customer group
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str
The description about the customer group.
display_name str
The display name of the customer group.
freeform_tags Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str
The OCID of the customer group.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
occ_customer_group_id str
The OCID of the customer group.
state str
The current lifecycle state of the resource.
status str
To determine whether the customer group is enabled/disabled.
system_tags Mapping[str, str]
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The time when the customer group was created.
time_updated str
The time when the customer group was last updated.
compartmentId String
The OCID of the tenancy containing the customer group.
customersLists List<Property Map>
A list containing all the customers that belong to this customer group
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
The description about the customer group.
displayName String
The display name of the customer group.
freeformTags Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String
The OCID of the customer group.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.
occCustomerGroupId String
The OCID of the customer group.
state String
The current lifecycle state of the resource.
status String
To determine whether the customer group is enabled/disabled.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time when the customer group was created.
timeUpdated String
The time when the customer group was last updated.

Supporting Types

GetOccCustomerGroupCustomersList

Description This property is required. string
The description about the customer group.
DisplayName This property is required. string
The display name of the customer group.
OccCustomerGroupId This property is required. string
The OCID of the customer group.
Status This property is required. string
To determine whether the customer group is enabled/disabled.
TenancyId This property is required. string
The OCID of the tenancy belonging to the customer.
Description This property is required. string
The description about the customer group.
DisplayName This property is required. string
The display name of the customer group.
OccCustomerGroupId This property is required. string
The OCID of the customer group.
Status This property is required. string
To determine whether the customer group is enabled/disabled.
TenancyId This property is required. string
The OCID of the tenancy belonging to the customer.
description This property is required. String
The description about the customer group.
displayName This property is required. String
The display name of the customer group.
occCustomerGroupId This property is required. String
The OCID of the customer group.
status This property is required. String
To determine whether the customer group is enabled/disabled.
tenancyId This property is required. String
The OCID of the tenancy belonging to the customer.
description This property is required. string
The description about the customer group.
displayName This property is required. string
The display name of the customer group.
occCustomerGroupId This property is required. string
The OCID of the customer group.
status This property is required. string
To determine whether the customer group is enabled/disabled.
tenancyId This property is required. string
The OCID of the tenancy belonging to the customer.
description This property is required. str
The description about the customer group.
display_name This property is required. str
The display name of the customer group.
occ_customer_group_id This property is required. str
The OCID of the customer group.
status This property is required. str
To determine whether the customer group is enabled/disabled.
tenancy_id This property is required. str
The OCID of the tenancy belonging to the customer.
description This property is required. String
The description about the customer group.
displayName This property is required. String
The display name of the customer group.
occCustomerGroupId This property is required. String
The OCID of the customer group.
status This property is required. String
To determine whether the customer group is enabled/disabled.
tenancyId This property is required. String
The OCID of the tenancy belonging to the customer.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi