Idioma

SyncAgentCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Namespace:
Azure.ResourceManager.Sql
Assembly:
Azure.ResourceManager.Sql.dll
Package:
Azure.ResourceManager.Sql v1.4.0
Package:
Azure.ResourceManager.Sql v1.5.0-beta.1
Source:
SyncAgentCollection.cs
Source:
SyncAgentCollection.cs

Tries to get details for this resource from the service.

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

Parameters

syncAgentName
String

The name of the sync agent.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<SyncAgentResource>>

Exceptions

ArgumentNullException

syncAgentName is null.

ArgumentException

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

Applies to