Class ConsumerGroup

Manages a Consumer Group within an IotHub

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
    {
        Location = "West US",
    });
    var exampleIoTHub = new Azure.Iot.IoTHub("exampleIoTHub", new Azure.Iot.IoTHubArgs
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
        {
            Name = "S1",
            Capacity = "1",
        },
        Tags = 
        {
            { "purpose", "testing" },
        },
    });
    var exampleConsumerGroup = new Azure.Iot.ConsumerGroup("exampleConsumerGroup", new Azure.Iot.ConsumerGroupArgs
    {
        IothubName = exampleIoTHub.Name,
        EventhubEndpointName = "events",
        ResourceGroupName = exampleResourceGroup.Name,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ConsumerGroup

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Iot

Assembly: Pulumi.Azure.dll

Syntax

public class ConsumerGroup : CustomResource

Constructors

ConsumerGroup(String, ConsumerGroupArgs, CustomResourceOptions)

Create a ConsumerGroup resource with the given unique name, arguments, and options.

Declaration

public ConsumerGroup(string name, ConsumerGroupArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ConsumerGroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

EventhubEndpointName

The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.

Declaration

public Output<string> EventhubEndpointName { get; }

Property Value

Type	Description
Output<System.String>

IothubName

The name of the IoT Hub. Changing this forces a new resource to be created.

Declaration

public Output<string> IothubName { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of this Consumer Group. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ConsumerGroupState, CustomResourceOptions)

Get an existing ConsumerGroup resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ConsumerGroup Get(string name, Input<string> id, ConsumerGroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ConsumerGroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ConsumerGroup