Share via


IConsumerGroupsOperations.CreateOrUpdateWithHttpMessagesAsync Method

Definition

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.EventHub.Models.ConsumerGroup>> CreateOrUpdateWithHttpMessagesAsync (string resourceGroupName, string namespaceName, string eventHubName, string consumerGroupName, string userMetadata = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateWithHttpMessagesAsync : string * string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.EventHub.Models.ConsumerGroup>>
Public Function CreateOrUpdateWithHttpMessagesAsync (resourceGroupName As String, namespaceName As String, eventHubName As String, consumerGroupName As String, Optional userMetadata As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of ConsumerGroup))

Parameters

resourceGroupName
String

Name of the resource group within the azure subscription.

namespaceName
String

The Namespace name

eventHubName
String

The Event Hub name

consumerGroupName
String

The consumer group name

userMetadata
String

User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to