EventHubsConsumerGroupCollection.CreateOrUpdateAsync Method

Definition

Namespace:

Azure.ResourceManager.EventHubs

Assembly:

Azure.ResourceManager.EventHubs.dll

Package:

Azure.ResourceManager.EventHubs v1.0.1

Source:

EventHubsConsumerGroupCollection.cs

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
• Operation Id: ConsumerGroups_CreateOrUpdate
• Default Api Version: 2023-01-01-preview
• Resource: EventHubsConsumerGroupResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string consumerGroupName, Azure.ResourceManager.EventHubs.EventHubsConsumerGroupData data, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.EventHubs.EventHubsConsumerGroupData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.EventHubs.EventHubsConsumerGroupData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>>

Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, consumerGroupName As String, data As EventHubsConsumerGroupData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of EventHubsConsumerGroupResource))

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.

consumerGroupName

String

The consumer group name.

data

EventHubsConsumerGroupData

Parameters supplied to create or update a consumer group resource.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<EventHubsConsumerGroupResource>>

Exceptions

ArgumentException

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

ArgumentNullException

consumerGroupName or data is null.