EventHubConsumerGroupInfoCollection.Get(String, CancellationToken) 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 Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource> Get (string name, System.Threading.CancellationToken cancellationToken = default);abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>Public Overridable Function Get (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EventHubConsumerGroupInfoResource)Parameters
- name
- String
The name of the consumer group to retrieve.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
name is an empty string, and was expected to be non-empty.
name is null.
