ConnectorClientBase Class

Definition

Namespace:
Azure.Connectors.Sdk
Assembly:
Azure.Connectors.Sdk.dll
Package:
Azure.Connectors.Sdk v0.13.0-preview.1

Abstract base class for generated connector clients. Provides shared infrastructure: authentication via Azure.Core HttpPipeline, JSON serialization, URL resolution with SSRF protection, and configurable retry/diagnostics through ConnectorClientOptions.

public abstract class ConnectorClientBase : IDisposable
type ConnectorClientBase = class
    interface IDisposable
Public MustInherit Class ConnectorClientBase
Implements IDisposable
Inheritance
Object
ConnectorClientBase
Derived
Implements
IDisposable

Constructors

Name Description
ConnectorClientBase()

Initializes a new instance of the ConnectorClientBase class. This constructor exists for mocking frameworks (e.g. Moq) and should not be used directly.
ConnectorClientBase(String)

Initializes a new instance of the ConnectorClientBase class with a string connection runtime URL. Uses ManagedIdentityCredential by default.
ConnectorClientBase(Uri, TokenCredential, ConnectorClientOptions)

Initializes a new instance of the ConnectorClientBase class with a connection runtime URL and explicit Azure credential.
ConnectorClientBase(Uri, TokenCredential)

Initializes a new instance of the ConnectorClientBase class with a connection runtime URL and explicit Azure credential.
ConnectorClientBase(Uri)

Initializes a new instance of the ConnectorClientBase class with a connection runtime URL. Uses ManagedIdentityCredential by default.

Fields

Name Description
ApiHubScopes

The default OAuth scopes for API Hub authentication.
JsonOptions

The default JSON serializer options for connector operations.

Properties

Name Description
ConnectorName
Pipeline

Gets the HTTP pipeline for making connector requests.

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.
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.
Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)

Disposes the connector client resources.
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.

Applies to