EventHubConsumerGroupInfoCollection.CreateOrUpdate Method

Definition

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
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string name, Azure.ResourceManager.IotHub.Models.EventHubConsumerGroupInfoCreateOrUpdateContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.IotHub.Models.EventHubConsumerGroupInfoCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.IotHub.Models.EventHubConsumerGroupInfoCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, name As String, content As EventHubConsumerGroupInfoCreateOrUpdateContent, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

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

name or content is null.

Applies to