SqlClient Class

Definition

Typed client for sql connector.

public class SqlClient : Azure.Connectors.Sdk.ConnectorClientBase
type SqlClient = class
    inherit ConnectorClientBase
Public Class SqlClient
Inherits ConnectorClientBase
Inheritance

Constructors

Name Description
SqlClient()
SqlClient(String)

Creates a new SqlClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.

SqlClient(Uri, TokenCredential, ConnectorClientOptions)

Creates a new SqlClient with the specified connection runtime URL and credential.

SqlClient(Uri, TokenCredential)

Creates a new SqlClient with the specified connection runtime URL and credential.

SqlClient(Uri)

Creates a new SqlClient with the specified connection runtime URL. Uses ManagedIdentityCredential by default.

Properties

Name Description
ConnectorName
Pipeline

Gets the HTTP pipeline for making connector requests.

(Inherited from ConnectorClientBase)

Methods

Name Description
CallConnectorAsync(HttpMethod, String, Object, CancellationToken)

Sends a connector API request with no response body. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics.

(Inherited from ConnectorClientBase)
CallConnectorAsync<TResponse>(HttpMethod, String, Object, CancellationToken)

Sends a connector API request and deserializes the JSON response. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics.

(Inherited from ConnectorClientBase)
DeleteItemAsync(String, String, String, String, CancellationToken)

Delete row (V2)

Dispose() (Inherited from ConnectorClientBase)
Dispose(Boolean)

Disposes the connector client resources.

(Inherited from ConnectorClientBase)
ExecutePassThroughNativeQueryAsync(String, String, SqlPassThroughNativeQueryBody, CancellationToken)

Execute a SQL query (V2)

ExecuteProcedureAsync(String, String, String, ExecuteProcedureInput, CancellationToken)

Execute stored procedure (V2)

GetDatabasesAsync(String, CancellationToken)

List the databases

GetItemAsync(String, String, String, String, CancellationToken)

Get row (V2)

GetItemsAsync(String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

Get rows (V2)

GetPassThroughNativeQueryMetadataAsync(String, String, SqlPassThroughNativeQueryBody, CancellationToken)

Get pass-through native SQL query metadata

GetProcedureAsync(String, String, String, CancellationToken)

Get metadata of a Procedure

GetProceduresAsync(String, String, CancellationToken)

Get stored procedures

GetServersAsync(CancellationToken)

List the servers

GetTableAsync(String, String, String, Nullable<Boolean>, String, CancellationToken)

Get metadata of a table

GetTableForPatchAsync(String, String, String, CancellationToken)

Get metadata of a table for Patch operation

GetTablesAsync(String, String, Nullable<Boolean>, String, CancellationToken)

Get tables (V2)

GetTablesForDeleteItemAsync(String, String, CancellationToken)

GetTablesForDeleteItem

GetTablesForGetItemAsync(String, String, CancellationToken)

GetTablesForGetItem

GetTablesForGetOnNewItemsAsync(String, String, CancellationToken)

GetTablesForOnItemCreated

GetTablesForGetOnUpdatedItemsAsync(String, String, CancellationToken)

GetTablesForOnItemUpdated

GetTablesForPatchItemAsync(String, String, CancellationToken)

GetTablesForPatchItem

GetTablesForPostItemAsync(String, String, CancellationToken)

GetTablesForPostItem

PatchItemAsync(String, String, String, String, PatchItemInput, CancellationToken)

Update row (V2)

PostItemAsync(String, String, String, PostItemInput, CancellationToken)

Insert row (V2)

ResolveUrl(String)

Resolves a relative path or validates an absolute URL against the connection runtime URL. When the NextLink host matches the connection URL, it's used as-is. When it doesn't match (codeless connectors like ARM return nextLink pointing to the backend host e.g. management.azure.com), the path+query is extracted and routed through the APIM proxy. This is safe because the request still goes through the connection runtime URL with API Hub auth.

(Inherited from ConnectorClientBase)

Applies to