Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. iothub
  5. getIotHubResourceEventHubConsumerGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.iothub.getIotHubResourceEventHubConsumerGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

Uses Azure REST API version 2023-06-30.

Other available API versions: 2016-02-03, 2017-01-19, 2017-07-01, 2018-01-22, 2018-04-01, 2018-12-01-preview, 2019-03-22, 2019-03-22-preview, 2019-07-01-preview, 2019-11-04, 2020-03-01, 2020-04-01, 2020-06-15, 2020-07-10-preview, 2020-08-01, 2020-08-31, 2020-08-31-preview, 2021-02-01-preview, 2021-03-03-preview, 2021-03-31, 2021-07-01, 2021-07-01-preview, 2021-07-02, 2021-07-02-preview, 2022-04-30-preview, 2022-11-15-preview, 2023-06-30-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native iothub [ApiVersion]. See the version guide for details.

Using getIotHubResourceEventHubConsumerGroup

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 getIotHubResourceEventHubConsumerGroup(args: GetIotHubResourceEventHubConsumerGroupArgs, opts?: InvokeOptions): Promise<GetIotHubResourceEventHubConsumerGroupResult>
function getIotHubResourceEventHubConsumerGroupOutput(args: GetIotHubResourceEventHubConsumerGroupOutputArgs, opts?: InvokeOptions): Output<GetIotHubResourceEventHubConsumerGroupResult>
Copy
def get_iot_hub_resource_event_hub_consumer_group(event_hub_endpoint_name: Optional[str] = None,
                                                  name: Optional[str] = None,
                                                  resource_group_name: Optional[str] = None,
                                                  resource_name: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetIotHubResourceEventHubConsumerGroupResult
def get_iot_hub_resource_event_hub_consumer_group_output(event_hub_endpoint_name: Optional[pulumi.Input[str]] = None,
                                                  name: Optional[pulumi.Input[str]] = None,
                                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                                  resource_name: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetIotHubResourceEventHubConsumerGroupResult]
Copy
func LookupIotHubResourceEventHubConsumerGroup(ctx *Context, args *LookupIotHubResourceEventHubConsumerGroupArgs, opts ...InvokeOption) (*LookupIotHubResourceEventHubConsumerGroupResult, error)
func LookupIotHubResourceEventHubConsumerGroupOutput(ctx *Context, args *LookupIotHubResourceEventHubConsumerGroupOutputArgs, opts ...InvokeOption) LookupIotHubResourceEventHubConsumerGroupResultOutput
Copy

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

public static class GetIotHubResourceEventHubConsumerGroup 
{
    public static Task<GetIotHubResourceEventHubConsumerGroupResult> InvokeAsync(GetIotHubResourceEventHubConsumerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetIotHubResourceEventHubConsumerGroupResult> Invoke(GetIotHubResourceEventHubConsumerGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIotHubResourceEventHubConsumerGroupResult> getIotHubResourceEventHubConsumerGroup(GetIotHubResourceEventHubConsumerGroupArgs args, InvokeOptions options)
public static Output<GetIotHubResourceEventHubConsumerGroupResult> getIotHubResourceEventHubConsumerGroup(GetIotHubResourceEventHubConsumerGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:iothub:getIotHubResourceEventHubConsumerGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EventHubEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Event Hub-compatible endpoint in the IoT hub.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the consumer group to retrieve.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
EventHubEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Event Hub-compatible endpoint in the IoT hub.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the consumer group to retrieve.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
eventHubEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Event Hub-compatible endpoint in the IoT hub.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the consumer group to retrieve.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoT hub.
eventHubEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Event Hub-compatible endpoint in the IoT hub.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the consumer group to retrieve.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
event_hub_endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Event Hub-compatible endpoint in the IoT hub.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the consumer group to retrieve.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the IoT hub.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the IoT hub.
eventHubEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Event Hub-compatible endpoint in the IoT hub.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the consumer group to retrieve.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoT hub.

getIotHubResourceEventHubConsumerGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
The etag.
Id string
The Event Hub-compatible consumer group identifier.
Name string
The Event Hub-compatible consumer group name.
Properties object
The tags.
Type string
the resource type.
AzureApiVersion string
The Azure API version of the resource.
Etag string
The etag.
Id string
The Event Hub-compatible consumer group identifier.
Name string
The Event Hub-compatible consumer group name.
Properties interface{}
The tags.
Type string
the resource type.
azureApiVersion String
The Azure API version of the resource.
etag String
The etag.
id String
The Event Hub-compatible consumer group identifier.
name String
The Event Hub-compatible consumer group name.
properties Object
The tags.
type String
the resource type.
azureApiVersion string
The Azure API version of the resource.
etag string
The etag.
id string
The Event Hub-compatible consumer group identifier.
name string
The Event Hub-compatible consumer group name.
properties any
The tags.
type string
the resource type.
azure_api_version str
The Azure API version of the resource.
etag str
The etag.
id str
The Event Hub-compatible consumer group identifier.
name str
The Event Hub-compatible consumer group name.
properties Any
The tags.
type str
the resource type.
azureApiVersion String
The Azure API version of the resource.
etag String
The etag.
id String
The Event Hub-compatible consumer group identifier.
name String
The Event Hub-compatible consumer group name.
properties Any
The tags.
type String
the resource type.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native