1. Packages
  2. Azure Native
  3. API Docs
  4. devices
  5. getIotHubResourceEventHubConsumerGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.devices.getIotHubResourceEventHubConsumerGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi

    Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Azure REST API version: 2022-04-30-preview.

    Other available API versions: 2017-07-01, 2021-03-03-preview, 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

    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>
    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]
    func LookupIotHubResourceEventHubConsumerGroup(ctx *Context, args *LookupIotHubResourceEventHubConsumerGroupArgs, opts ...InvokeOption) (*LookupIotHubResourceEventHubConsumerGroupResult, error)
    func LookupIotHubResourceEventHubConsumerGroupOutput(ctx *Context, args *LookupIotHubResourceEventHubConsumerGroupOutputArgs, opts ...InvokeOption) LookupIotHubResourceEventHubConsumerGroupResultOutput

    > 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)
    }
    public static CompletableFuture<GetIotHubResourceEventHubConsumerGroupResult> getIotHubResourceEventHubConsumerGroup(GetIotHubResourceEventHubConsumerGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:devices:getIotHubResourceEventHubConsumerGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EventHubEndpointName string
    The name of the Event Hub-compatible endpoint in the IoT hub.
    Name string
    The name of the consumer group to retrieve.
    ResourceGroupName string
    The name of the resource group that contains the IoT hub.
    ResourceName string
    The name of the IoT hub.
    EventHubEndpointName string
    The name of the Event Hub-compatible endpoint in the IoT hub.
    Name string
    The name of the consumer group to retrieve.
    ResourceGroupName string
    The name of the resource group that contains the IoT hub.
    ResourceName string
    The name of the IoT hub.
    eventHubEndpointName String
    The name of the Event Hub-compatible endpoint in the IoT hub.
    name String
    The name of the consumer group to retrieve.
    resourceGroupName String
    The name of the resource group that contains the IoT hub.
    resourceName String
    The name of the IoT hub.
    eventHubEndpointName string
    The name of the Event Hub-compatible endpoint in the IoT hub.
    name string
    The name of the consumer group to retrieve.
    resourceGroupName string
    The name of the resource group that contains the IoT hub.
    resourceName string
    The name of the IoT hub.
    event_hub_endpoint_name str
    The name of the Event Hub-compatible endpoint in the IoT hub.
    name str
    The name of the consumer group to retrieve.
    resource_group_name str
    The name of the resource group that contains the IoT hub.
    resource_name str
    The name of the IoT hub.
    eventHubEndpointName String
    The name of the Event Hub-compatible endpoint in the IoT hub.
    name String
    The name of the consumer group to retrieve.
    resourceGroupName String
    The name of the resource group that contains the IoT hub.
    resourceName String
    The name of the IoT hub.

    getIotHubResourceEventHubConsumerGroup Result

    The following output properties are available:

    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.
    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.
    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.
    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.
    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.
    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.29.0 published on Friday, Feb 16, 2024 by Pulumi