EventHubsExtensions.GetEventHubsClusterAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.EventHubs

Assembly:: Azure.ResourceManager.EventHubs.dll

Package:: Azure.ResourceManager.EventHubs v1.0.1

Package:: Azure.ResourceManager.EventHubs v1.1.0-beta.5

Source:: EventHubsExtensions.cs

Source:: EventHubsExtensions.cs

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.

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: 2022-10-01-preview
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

Task<Response<EventHubsClusterResource>>

Exceptions

ArgumentNullException

resourceGroupResource or clusterName is null.

ArgumentException

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

Applies to