SqlServerResource.GetSyncAgentAsync(String, CancellationToken) Method

Definition

Gets a sync agent.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}
  • Operation Id: SyncAgents_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SyncAgentResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sql.SyncAgentResource>> GetSyncAgentAsync (string syncAgentName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSyncAgentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sql.SyncAgentResource>>
override this.GetSyncAgentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sql.SyncAgentResource>>
Public Overridable Function GetSyncAgentAsync (syncAgentName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SyncAgentResource))

Parameters

syncAgentName
String

The name of the sync agent.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

syncAgentName is null.

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

Applies to