IotHubDescriptionResource.GetEventHubConsumerGroupInfoAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
- Operation Id: IotHubResource_GetEventHubConsumerGroup
- Default Api Version: 2023-06-30
- Resource: EventHubConsumerGroupInfoResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>> GetEventHubConsumerGroupInfoAsync (string eventHubEndpointName, string name, System.Threading.CancellationToken cancellationToken = default);
abstract member GetEventHubConsumerGroupInfoAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>>
override this.GetEventHubConsumerGroupInfoAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>>
Public Overridable Function GetEventHubConsumerGroupInfoAsync (eventHubEndpointName As String, name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EventHubConsumerGroupInfoResource))
Parameters
- eventHubEndpointName
- String
The name of the Event Hub-compatible endpoint.
- name
- String
The name of the consumer group to retrieve.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
eventHubEndpointName
or name
is null.
eventHubEndpointName
or name
is an empty string, and was expected to be non-empty.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for .NET