SqlServerResource.GetSyncAgent(String, CancellationToken) Method
Definition
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 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 Azure.Response<Azure.ResourceManager.Sql.SyncAgentResource> GetSyncAgent (string syncAgentName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSyncAgent : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sql.SyncAgentResource>
override this.GetSyncAgent : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sql.SyncAgentResource>
Public Overridable Function GetSyncAgent (syncAgentName As String, Optional cancellationToken As CancellationToken = Nothing) As 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.