Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getConsumerGroup

Single item in List or Get Consumer group operation API Version: 2017-04-01.

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_name: Optional[str] = None,
                       event_hub_name: Optional[str] = None,
                       namespace_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetConsumerGroupResult
def get_consumer_group_output(consumer_group_name: Optional[pulumi.Input[str]] = None,
                       event_hub_name: Optional[pulumi.Input[str]] = None,
                       namespace_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: 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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:eventhub:getConsumerGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ConsumerGroupName string

The consumer group name

EventHubName string

The Event Hub name

NamespaceName string

The Namespace name

ResourceGroupName string

Name of the resource group within the azure subscription.

ConsumerGroupName string

The consumer group name

EventHubName string

The Event Hub name

NamespaceName string

The Namespace name

ResourceGroupName string

Name of the resource group within the azure subscription.

consumerGroupName String

The consumer group name

eventHubName String

The Event Hub name

namespaceName String

The Namespace name

resourceGroupName String

Name of the resource group within the azure subscription.

consumerGroupName string

The consumer group name

eventHubName string

The Event Hub name

namespaceName string

The Namespace name

resourceGroupName string

Name of the resource group within the azure subscription.

consumer_group_name str

The consumer group name

event_hub_name str

The Event Hub name

namespace_name str

The Namespace name

resource_group_name str

Name of the resource group within the azure subscription.

consumerGroupName String

The consumer group name

eventHubName String

The Event Hub name

namespaceName String

The Namespace name

resourceGroupName String

Name of the resource group within the azure subscription.

getConsumerGroup Result

The following output properties are available:

CreatedAt string

Exact time the message was created.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

UpdatedAt string

The exact time the message was updated.

UserMetadata string

User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

CreatedAt string

Exact time the message was created.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

UpdatedAt string

The exact time the message was updated.

UserMetadata string

User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

createdAt String

Exact time the message was created.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

updatedAt String

The exact time the message was updated.

userMetadata String

User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

createdAt string

Exact time the message was created.

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name string

The name of the resource

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

updatedAt string

The exact time the message was updated.

userMetadata string

User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

created_at str

Exact time the message was created.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name str

The name of the resource

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

updated_at str

The exact time the message was updated.

user_metadata str

User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

createdAt String

Exact time the message was created.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

updatedAt String

The exact time the message was updated.

userMetadata String

User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0