EventHubsClusterCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Tries to get details for this resource from the service.

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

Parameters

clusterName
String

The name of the Event Hubs Cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

clusterName is null.

Applies to