EventHubConsumerGroupInfoCollection.CreateOrUpdateAsync Method

Definition

Namespace:

Azure.ResourceManager.IotHub

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

EventHubConsumerGroupInfoCollection.cs

Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
• Operation Id: IotHubResource_CreateEventHubConsumerGroup
• Default Api Version: 2023-06-30
• Resource: EventHubConsumerGroupInfoResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string name, Azure.ResourceManager.IotHub.Models.EventHubConsumerGroupInfoCreateOrUpdateContent content, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.IotHub.Models.EventHubConsumerGroupInfoCreateOrUpdateContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.IotHub.Models.EventHubConsumerGroupInfoCreateOrUpdateContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>>

Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, name As String, content As EventHubConsumerGroupInfoCreateOrUpdateContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of EventHubConsumerGroupInfoResource))

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

name

String

The name of the consumer group to add.

content

EventHubConsumerGroupInfoCreateOrUpdateContent

The consumer group to add.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<EventHubConsumerGroupInfoResource>>

Exceptions

ArgumentException

name is an empty string, and was expected to be non-empty.

ArgumentNullException

name or content is null.