Language

RelayExtensions.GetRelayClusterAsync Method

Definition

Gets a Relay cluster. <item> Mocking. To mock this method, please mock GetRelayClusterAsync(String, CancellationToken) instead. </item>

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Relay.RelayClusterResource>> GetRelayClusterAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);
static member GetRelayClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Relay.RelayClusterResource>>
<Extension()>
Public Function GetRelayClusterAsync (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RelayClusterResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource the method will execute against.

clusterName
String

The name of the Relay cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource is null.

Applies to