azure-native.iothub.IotHubResourceEventHubConsumerGroup
Explore with Pulumi AI
The properties of the EventHubConsumerGroupInfo object.
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.
Create IotHubResourceEventHubConsumerGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IotHubResourceEventHubConsumerGroup(name: string, args: IotHubResourceEventHubConsumerGroupArgs, opts?: CustomResourceOptions);
@overload
def IotHubResourceEventHubConsumerGroup(resource_name: str,
args: IotHubResourceEventHubConsumerGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IotHubResourceEventHubConsumerGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
event_hub_endpoint_name: Optional[str] = None,
properties: Optional[EventHubConsumerGroupNameArgs] = None,
resource_group_name: Optional[str] = None,
resource_name_: Optional[str] = None,
name: Optional[str] = None)
func NewIotHubResourceEventHubConsumerGroup(ctx *Context, name string, args IotHubResourceEventHubConsumerGroupArgs, opts ...ResourceOption) (*IotHubResourceEventHubConsumerGroup, error)
public IotHubResourceEventHubConsumerGroup(string name, IotHubResourceEventHubConsumerGroupArgs args, CustomResourceOptions? opts = null)
public IotHubResourceEventHubConsumerGroup(String name, IotHubResourceEventHubConsumerGroupArgs args)
public IotHubResourceEventHubConsumerGroup(String name, IotHubResourceEventHubConsumerGroupArgs args, CustomResourceOptions options)
type: azure-native:iothub:IotHubResourceEventHubConsumerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. IotHubResourceEventHubConsumerGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. IotHubResourceEventHubConsumerGroupArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. IotHubResourceEventHubConsumerGroupArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. IotHubResourceEventHubConsumerGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. IotHubResourceEventHubConsumerGroupArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var iotHubResourceEventHubConsumerGroupResource = new AzureNative.IoTHub.IotHubResourceEventHubConsumerGroup("iotHubResourceEventHubConsumerGroupResource", new()
{
EventHubEndpointName = "string",
Properties = new AzureNative.IoTHub.Inputs.EventHubConsumerGroupNameArgs
{
Name = "string",
},
ResourceGroupName = "string",
ResourceName = "string",
Name = "string",
});
example, err := iothub.NewIotHubResourceEventHubConsumerGroup(ctx, "iotHubResourceEventHubConsumerGroupResource", &iothub.IotHubResourceEventHubConsumerGroupArgs{
EventHubEndpointName: pulumi.String("string"),
Properties: &iothub.EventHubConsumerGroupNameArgs{
Name: pulumi.String("string"),
},
ResourceGroupName: pulumi.String("string"),
ResourceName: pulumi.String("string"),
Name: pulumi.String("string"),
})
var iotHubResourceEventHubConsumerGroupResource = new IotHubResourceEventHubConsumerGroup("iotHubResourceEventHubConsumerGroupResource", IotHubResourceEventHubConsumerGroupArgs.builder()
.eventHubEndpointName("string")
.properties(EventHubConsumerGroupNameArgs.builder()
.name("string")
.build())
.resourceGroupName("string")
.resourceName("string")
.name("string")
.build());
iot_hub_resource_event_hub_consumer_group_resource = azure_native.iothub.IotHubResourceEventHubConsumerGroup("iotHubResourceEventHubConsumerGroupResource",
event_hub_endpoint_name="string",
properties={
"name": "string",
},
resource_group_name="string",
resource_name_="string",
name="string")
const iotHubResourceEventHubConsumerGroupResource = new azure_native.iothub.IotHubResourceEventHubConsumerGroup("iotHubResourceEventHubConsumerGroupResource", {
eventHubEndpointName: "string",
properties: {
name: "string",
},
resourceGroupName: "string",
resourceName: "string",
name: "string",
});
type: azure-native:iothub:IotHubResourceEventHubConsumerGroup
properties:
eventHubEndpointName: string
name: string
properties:
name: string
resourceGroupName: string
resourceName: string
IotHubResourceEventHubConsumerGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The IotHubResourceEventHubConsumerGroup resource accepts the following input properties:
- Event
Hub Endpoint Name This property is required. Changes to this property will trigger replacement.
- The name of the Event Hub-compatible endpoint in the IoT hub.
- Properties
This property is required. Pulumi.Azure Native. Io THub. Inputs. Event Hub Consumer Group Name - The EventHub consumer group name.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the IoT hub.
- Resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the IoT hub.
- Name
Changes to this property will trigger replacement.
- The name of the consumer group to add.
- Event
Hub Endpoint Name This property is required. Changes to this property will trigger replacement.
- The name of the Event Hub-compatible endpoint in the IoT hub.
- Properties
This property is required. EventHub Consumer Group Name Args - The EventHub consumer group name.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the IoT hub.
- Resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the IoT hub.
- Name
Changes to this property will trigger replacement.
- The name of the consumer group to add.
- event
Hub Endpoint Name This property is required. Changes to this property will trigger replacement.
- The name of the Event Hub-compatible endpoint in the IoT hub.
- properties
This property is required. EventHub Consumer Group Name - The EventHub consumer group name.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the IoT hub.
- resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the IoT hub.
- name
Changes to this property will trigger replacement.
- The name of the consumer group to add.
- event
Hub Endpoint Name This property is required. Changes to this property will trigger replacement.
- The name of the Event Hub-compatible endpoint in the IoT hub.
- properties
This property is required. EventHub Consumer Group Name - The EventHub consumer group name.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the IoT hub.
- resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the IoT hub.
- name
Changes to this property will trigger replacement.
- The name of the consumer group to add.
- event_
hub_ endpoint_ name This property is required. Changes to this property will trigger replacement.
- The name of the Event Hub-compatible endpoint in the IoT hub.
- properties
This property is required. EventHub Consumer Group Name Args - The EventHub consumer group name.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the IoT hub.
- resource_
name This property is required. Changes to this property will trigger replacement.
- The name of the IoT hub.
- name
Changes to this property will trigger replacement.
- The name of the consumer group to add.
- event
Hub Endpoint Name This property is required. Changes to this property will trigger replacement.
- The name of the Event Hub-compatible endpoint in the IoT hub.
- properties
This property is required. Property Map - The EventHub consumer group name.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the IoT hub.
- resource
Name This property is required. Changes to this property will trigger replacement.
- The name of the IoT hub.
- name
Changes to this property will trigger replacement.
- The name of the consumer group to add.
Outputs
All input properties are implicitly available as output properties. Additionally, the IotHubResourceEventHubConsumerGroup resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- The etag.
- Id string
- The provider-assigned unique ID for this managed resource.
- Type string
- the resource type.
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- The etag.
- Id string
- The provider-assigned unique ID for this managed resource.
- Type string
- the resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- The etag.
- id String
- The provider-assigned unique ID for this managed resource.
- type String
- the resource type.
- azure
Api stringVersion - The Azure API version of the resource.
- etag string
- The etag.
- id string
- The provider-assigned unique ID for this managed resource.
- type string
- the resource type.
- azure_
api_ strversion - The Azure API version of the resource.
- etag str
- The etag.
- id str
- The provider-assigned unique ID for this managed resource.
- type str
- the resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- The etag.
- id String
- The provider-assigned unique ID for this managed resource.
- type String
- the resource type.
Supporting Types
EventHubConsumerGroupName, EventHubConsumerGroupNameArgs
- Name
This property is required. string - EventHub consumer group name
- Name
This property is required. string - EventHub consumer group name
- name
This property is required. String - EventHub consumer group name
- name
This property is required. string - EventHub consumer group name
- name
This property is required. str - EventHub consumer group name
- name
This property is required. String - EventHub consumer group name
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:iothub:IotHubResourceEventHubConsumerGroup test /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0