Language

MockableRelayResourceGroupResource.GetRelayClusterAsync Method

Definition

Gets a Relay cluster.

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

Parameters

clusterName
String

The name of the Relay cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

clusterName is null.

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

Applies to