EventHubsExtensions.GetEventHubsClusterAsync Method

Definition

Gets the resource description of the specified Event Hubs Cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.EventHubs.EventHubsClusterResource>> GetEventHubsClusterAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);
static member GetEventHubsClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.EventHubs.EventHubsClusterResource>>
<Extension()>
Public Function GetEventHubsClusterAsync (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EventHubsClusterResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

clusterName
String

The name of the Event Hubs Cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or clusterName is null.

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

Applies to