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