1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CapacityManagement
  5. getOccCustomerGroups
Oracle Cloud Infrastructure v1.36.0 published on Thursday, May 16, 2024 by Pulumi

oci.CapacityManagement.getOccCustomerGroups

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.36.0 published on Thursday, May 16, 2024 by Pulumi

    This data source provides the list of Occ Customer Groups in Oracle Cloud Infrastructure Capacity Management service.

    Lists all the customer groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testOccCustomerGroups = oci.CapacityManagement.getOccCustomerGroups({
        compartmentId: compartmentId,
        displayName: occCustomerGroupDisplayName,
        id: occCustomerGroupId,
        status: occCustomerGroupStatus,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_occ_customer_groups = oci.CapacityManagement.get_occ_customer_groups(compartment_id=compartment_id,
        display_name=occ_customer_group_display_name,
        id=occ_customer_group_id,
        status=occ_customer_group_status)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/CapacityManagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := CapacityManagement.GetOccCustomerGroups(ctx, &capacitymanagement.GetOccCustomerGroupsArgs{
    			CompartmentId: compartmentId,
    			DisplayName:   pulumi.StringRef(occCustomerGroupDisplayName),
    			Id:            pulumi.StringRef(occCustomerGroupId),
    			Status:        pulumi.StringRef(occCustomerGroupStatus),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testOccCustomerGroups = Oci.CapacityManagement.GetOccCustomerGroups.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = occCustomerGroupDisplayName,
            Id = occCustomerGroupId,
            Status = occCustomerGroupStatus,
        });
    
    });
    
    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.GetOccCustomerGroupsArgs;
    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 testOccCustomerGroups = CapacityManagementFunctions.getOccCustomerGroups(GetOccCustomerGroupsArgs.builder()
                .compartmentId(compartmentId)
                .displayName(occCustomerGroupDisplayName)
                .id(occCustomerGroupId)
                .status(occCustomerGroupStatus)
                .build());
    
        }
    }
    
    variables:
      testOccCustomerGroups:
        fn::invoke:
          Function: oci:CapacityManagement:getOccCustomerGroups
          Arguments:
            compartmentId: ${compartmentId}
            displayName: ${occCustomerGroupDisplayName}
            id: ${occCustomerGroupId}
            status: ${occCustomerGroupStatus}
    

    Using getOccCustomerGroups

    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 getOccCustomerGroups(args: GetOccCustomerGroupsArgs, opts?: InvokeOptions): Promise<GetOccCustomerGroupsResult>
    function getOccCustomerGroupsOutput(args: GetOccCustomerGroupsOutputArgs, opts?: InvokeOptions): Output<GetOccCustomerGroupsResult>
    def get_occ_customer_groups(compartment_id: Optional[str] = None,
                                display_name: Optional[str] = None,
                                filters: Optional[Sequence[_capacitymanagement.GetOccCustomerGroupsFilter]] = None,
                                id: Optional[str] = None,
                                status: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetOccCustomerGroupsResult
    def get_occ_customer_groups_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                display_name: Optional[pulumi.Input[str]] = None,
                                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_capacitymanagement.GetOccCustomerGroupsFilterArgs]]]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                status: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetOccCustomerGroupsResult]
    func GetOccCustomerGroups(ctx *Context, args *GetOccCustomerGroupsArgs, opts ...InvokeOption) (*GetOccCustomerGroupsResult, error)
    func GetOccCustomerGroupsOutput(ctx *Context, args *GetOccCustomerGroupsOutputArgs, opts ...InvokeOption) GetOccCustomerGroupsResultOutput

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

    public static class GetOccCustomerGroups 
    {
        public static Task<GetOccCustomerGroupsResult> InvokeAsync(GetOccCustomerGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetOccCustomerGroupsResult> Invoke(GetOccCustomerGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOccCustomerGroupsResult> getOccCustomerGroups(GetOccCustomerGroupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:CapacityManagement/getOccCustomerGroups:getOccCustomerGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    DisplayName string
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    Filters List<GetOccCustomerGroupsFilter>
    Id string
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    Status string
    A query filter to return the list result based on status.
    CompartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    DisplayName string
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    Filters []GetOccCustomerGroupsFilter
    Id string
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    Status string
    A query filter to return the list result based on status.
    compartmentId String
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    displayName String
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    filters List<GetOccCustomerGroupsFilter>
    id String
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    status String
    A query filter to return the list result based on status.
    compartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    displayName string
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    filters GetOccCustomerGroupsFilter[]
    id string
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    status string
    A query filter to return the list result based on status.
    compartment_id str
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    display_name str
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    filters Sequence[capacitymanagement.GetOccCustomerGroupsFilter]
    id str
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    status str
    A query filter to return the list result based on status.
    compartmentId String
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    displayName String
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    filters List<Property Map>
    id String
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    status String
    A query filter to return the list result based on status.

    getOccCustomerGroups Result

    The following output properties are available:

    CompartmentId string
    The OCID of the tenancy containing the customer group.
    OccCustomerGroupCollections List<GetOccCustomerGroupsOccCustomerGroupCollection>
    The list of occ_customer_group_collection.
    DisplayName string
    The display name of the customer group.
    Filters List<GetOccCustomerGroupsFilter>
    Id string
    The OCID of the customer group.
    Status string
    To determine whether the customer group is enabled/disabled.
    CompartmentId string
    The OCID of the tenancy containing the customer group.
    OccCustomerGroupCollections []GetOccCustomerGroupsOccCustomerGroupCollection
    The list of occ_customer_group_collection.
    DisplayName string
    The display name of the customer group.
    Filters []GetOccCustomerGroupsFilter
    Id string
    The OCID of the customer group.
    Status string
    To determine whether the customer group is enabled/disabled.
    compartmentId String
    The OCID of the tenancy containing the customer group.
    occCustomerGroupCollections List<GetOccCustomerGroupsOccCustomerGroupCollection>
    The list of occ_customer_group_collection.
    displayName String
    The display name of the customer group.
    filters List<GetOccCustomerGroupsFilter>
    id String
    The OCID of the customer group.
    status String
    To determine whether the customer group is enabled/disabled.
    compartmentId string
    The OCID of the tenancy containing the customer group.
    occCustomerGroupCollections GetOccCustomerGroupsOccCustomerGroupCollection[]
    The list of occ_customer_group_collection.
    displayName string
    The display name of the customer group.
    filters GetOccCustomerGroupsFilter[]
    id string
    The OCID of the customer group.
    status string
    To determine whether the customer group is enabled/disabled.
    compartment_id str
    The OCID of the tenancy containing the customer group.
    occ_customer_group_collections Sequence[capacitymanagement.GetOccCustomerGroupsOccCustomerGroupCollection]
    The list of occ_customer_group_collection.
    display_name str
    The display name of the customer group.
    filters Sequence[capacitymanagement.GetOccCustomerGroupsFilter]
    id str
    The OCID of the customer group.
    status str
    To determine whether the customer group is enabled/disabled.
    compartmentId String
    The OCID of the tenancy containing the customer group.
    occCustomerGroupCollections List<Property Map>
    The list of occ_customer_group_collection.
    displayName String
    The display name of the customer group.
    filters List<Property Map>
    id String
    The OCID of the customer group.
    status String
    To determine whether the customer group is enabled/disabled.

    Supporting Types

    GetOccCustomerGroupsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetOccCustomerGroupsOccCustomerGroupCollection

    GetOccCustomerGroupsOccCustomerGroupCollectionItem

    CompartmentId string
    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    CustomersLists List<GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList>
    A list containing all the customers that belong to this customer group
    DefinedTags Dictionary<string, object>
    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
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    FreeformTags Dictionary<string, object>
    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
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    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.
    State string
    The current lifecycle state of the resource.
    Status string
    A query filter to return the list result based on status.
    SystemTags Dictionary<string, object>
    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 compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    CustomersLists []GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList
    A list containing all the customers that belong to this customer group
    DefinedTags map[string]interface{}
    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
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    FreeformTags map[string]interface{}
    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
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    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.
    State string
    The current lifecycle state of the resource.
    Status string
    A query filter to return the list result based on status.
    SystemTags map[string]interface{}
    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 compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    customersLists List<GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList>
    A list containing all the customers that belong to this customer group
    definedTags Map<String,Object>
    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
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    freeformTags Map<String,Object>
    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
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    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.
    state String
    The current lifecycle state of the resource.
    status String
    A query filter to return the list result based on status.
    systemTags Map<String,Object>
    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 compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    customersLists GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList[]
    A list containing all the customers that belong to this customer group
    definedTags {[key: string]: any}
    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
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    freeformTags {[key: string]: any}
    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
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    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.
    state string
    The current lifecycle state of the resource.
    status string
    A query filter to return the list result based on status.
    systemTags {[key: string]: any}
    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 compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    customers_lists Sequence[capacitymanagement.GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList]
    A list containing all the customers that belong to this customer group
    defined_tags Mapping[str, Any]
    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
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    freeform_tags Mapping[str, Any]
    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
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    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.
    state str
    The current lifecycle state of the resource.
    status str
    A query filter to return the list result based on status.
    system_tags Mapping[str, Any]
    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 compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.
    customersLists List<Property Map>
    A list containing all the customers that belong to this customer group
    definedTags Map<Any>
    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
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    freeformTags Map<Any>
    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
    A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.
    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.
    state String
    The current lifecycle state of the resource.
    status String
    A query filter to return the list result based on status.
    systemTags Map<Any>
    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.

    GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList

    Description string
    The description about the customer group.
    DisplayName string
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    OccCustomerGroupId string
    The OCID of the customer group.
    Status string
    A query filter to return the list result based on status.
    TenancyId string
    The OCID of the tenancy belonging to the customer.
    Description string
    The description about the customer group.
    DisplayName string
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    OccCustomerGroupId string
    The OCID of the customer group.
    Status string
    A query filter to return the list result based on status.
    TenancyId string
    The OCID of the tenancy belonging to the customer.
    description String
    The description about the customer group.
    displayName String
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    occCustomerGroupId String
    The OCID of the customer group.
    status String
    A query filter to return the list result based on status.
    tenancyId String
    The OCID of the tenancy belonging to the customer.
    description string
    The description about the customer group.
    displayName string
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    occCustomerGroupId string
    The OCID of the customer group.
    status string
    A query filter to return the list result based on status.
    tenancyId string
    The OCID of the tenancy belonging to the customer.
    description str
    The description about the customer group.
    display_name str
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    occ_customer_group_id str
    The OCID of the customer group.
    status str
    A query filter to return the list result based on status.
    tenancy_id str
    The OCID of the tenancy belonging to the customer.
    description String
    The description about the customer group.
    displayName String
    A filter to return only the resources that match the entire display name. The match is not case sensitive.
    occCustomerGroupId String
    The OCID of the customer group.
    status String
    A query filter to return the list result based on status.
    tenancyId 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.
    oci logo
    Oracle Cloud Infrastructure v1.36.0 published on Thursday, May 16, 2024 by Pulumi