1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Queue
  5. getConsumerGroup
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Queue.getConsumerGroup

oci logo
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Consumer Group resource in Oracle Cloud Infrastructure Queue service.

    Gets a consumer group by identifier.

    Example Usage

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

const testConsumerGroup = oci.Queue.getConsumerGroup({
    consumerGroupId: testConsumerGroupOciQueueConsumerGroup.id,
});

    import pulumi
import pulumi_oci as oci

test_consumer_group = oci.Queue.get_consumer_group(consumer_group_id=test_consumer_group_oci_queue_consumer_group["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := queue.GetConsumerGroup(ctx, &queue.GetConsumerGroupArgs{
			ConsumerGroupId: testConsumerGroupOciQueueConsumerGroup.Id,
		}, 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 testConsumerGroup = Oci.Queue.GetConsumerGroup.Invoke(new()
    {
        ConsumerGroupId = testConsumerGroupOciQueueConsumerGroup.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Queue.QueueFunctions;
import com.pulumi.oci.Queue.inputs.GetConsumerGroupArgs;
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 testConsumerGroup = QueueFunctions.getConsumerGroup(GetConsumerGroupArgs.builder()
            .consumerGroupId(testConsumerGroupOciQueueConsumerGroup.id())
            .build());

    }
}

    variables:
  testConsumerGroup:
    fn::invoke:
      function: oci:Queue:getConsumerGroup
      arguments:
        consumerGroupId: ${testConsumerGroupOciQueueConsumerGroup.id}

    Using getConsumerGroup

    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 getConsumerGroup(args: GetConsumerGroupArgs, opts?: InvokeOptions): Promise<GetConsumerGroupResult>
function getConsumerGroupOutput(args: GetConsumerGroupOutputArgs, opts?: InvokeOptions): Output<GetConsumerGroupResult>
    def get_consumer_group(consumer_group_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetConsumerGroupResult
def get_consumer_group_output(consumer_group_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetConsumerGroupResult]
    func LookupConsumerGroup(ctx *Context, args *LookupConsumerGroupArgs, opts ...InvokeOption) (*LookupConsumerGroupResult, error)
func LookupConsumerGroupOutput(ctx *Context, args *LookupConsumerGroupOutputArgs, opts ...InvokeOption) LookupConsumerGroupResultOutput

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

    public static class GetConsumerGroup 
{
    public static Task<GetConsumerGroupResult> InvokeAsync(GetConsumerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetConsumerGroupResult> Invoke(GetConsumerGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConsumerGroupResult> getConsumerGroup(GetConsumerGroupArgs args, InvokeOptions options)
public static Output<GetConsumerGroupResult> getConsumerGroup(GetConsumerGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Queue/getConsumerGroup:getConsumerGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConsumerGroupId string
    The unique consumer group identifier.
    ConsumerGroupId string
    The unique consumer group identifier.
    consumerGroupId String
    The unique consumer group identifier.
    consumerGroupId string
    The unique consumer group identifier.
    consumer_group_id str
    The unique consumer group identifier.
    consumerGroupId String
    The unique consumer group identifier.

    getConsumerGroup Result

    The following output properties are available:

    ConsumerGroupFilter string
    The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. The primary consumer group cannot have any filter.
    ConsumerGroupId string
    DeadLetterQueueDeliveryCount int
    The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
    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
    A unique identifier for the consumer group that is immutable on creation.
    IsEnabled bool
    LifecycleDetails string
    Any additional details about the current state of the consumer group.
    QueueId string
    The OCID of the associated queue.
    State string
    The current state of the consumer group.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    ConsumerGroupFilter string
    The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. The primary consumer group cannot have any filter.
    ConsumerGroupId string
    DeadLetterQueueDeliveryCount int
    The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
    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
    A unique identifier for the consumer group that is immutable on creation.
    IsEnabled bool
    LifecycleDetails string
    Any additional details about the current state of the consumer group.
    QueueId string
    The OCID of the associated queue.
    State string
    The current state of the consumer group.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumerGroupFilter String
    The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. The primary consumer group cannot have any filter.
    consumerGroupId String
    deadLetterQueueDeliveryCount Integer
    The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
    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
    A unique identifier for the consumer group that is immutable on creation.
    isEnabled Boolean
    lifecycleDetails String
    Any additional details about the current state of the consumer group.
    queueId String
    The OCID of the associated queue.
    state String
    The current state of the consumer group.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumerGroupFilter string
    The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. The primary consumer group cannot have any filter.
    consumerGroupId string
    deadLetterQueueDeliveryCount number
    The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
    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
    A unique identifier for the consumer group that is immutable on creation.
    isEnabled boolean
    lifecycleDetails string
    Any additional details about the current state of the consumer group.
    queueId string
    The OCID of the associated queue.
    state string
    The current state of the consumer group.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time that the consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated string
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumer_group_filter str
    The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. The primary consumer group cannot have any filter.
    consumer_group_id str
    dead_letter_queue_delivery_count int
    The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level.
    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"}
    display_name str
    A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
    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
    A unique identifier for the consumer group that is immutable on creation.
    is_enabled bool
    lifecycle_details str
    Any additional details about the current state of the consumer group.
    queue_id str
    The OCID of the associated queue.
    state str
    The current state of the consumer group.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time that the consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    time_updated str
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumerGroupFilter String
    The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. The primary consumer group cannot have any filter.
    consumerGroupId String
    deadLetterQueueDeliveryCount Number
    The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
    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
    A unique identifier for the consumer group that is immutable on creation.
    isEnabled Boolean
    lifecycleDetails String
    Any additional details about the current state of the consumer group.
    queueId String
    The OCID of the associated queue.
    state String
    The current state of the consumer group.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    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 v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate