DocumentDbClient Class

Definition

Namespace:

Azure.Connectors.Sdk.Documentdb

Assembly:

Azure.Connectors.Sdk.dll

Package:

Azure.Connectors.Sdk v0.13.0-preview.1

Typed client for documentdb connector.

public class DocumentDbClient : Azure.Connectors.Sdk.ConnectorClientBase

type DocumentDbClient = class
    inherit ConnectorClientBase

Public Class DocumentDbClient
Inherits ConnectorClientBase

Inheritance

Object

ConnectorClientBase

DocumentDbClient

Constructors

Name	Description
DocumentDbClient()
DocumentDbClient(String)	Creates a new DocumentDbClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.
DocumentDbClient(Uri, TokenCredential, ConnectorClientOptions)	Creates a new DocumentDbClient with the specified connection runtime URL and credential.
DocumentDbClient(Uri, TokenCredential)	Creates a new DocumentDbClient with the specified connection runtime URL and credential.
DocumentDbClient(Uri)	Creates a new DocumentDbClient 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)
CreateDocumentAsync(String, String, String, PostDocumentsRequest, CancellationToken)	Create or update document (V3)
CreateStoredProcedureAsync(String, String, String, CreateStoredProcedureInput, CancellationToken)	Create stored procedure (V2)
DeleteDocumentAsync(String, String, String, String, CancellationToken)	Delete a document (V2)
DeleteStoredProcedureAsync(String, String, String, String, CancellationToken)	Delete stored procedure (V2)
Dispose()	(Inherited from ConnectorClientBase)
Dispose(Boolean)	Disposes the connector client resources. (Inherited from ConnectorClientBase)
ExecuteStoredProcedureAsync(String, String, String, String, String, CancellationToken)	Execute stored procedure (V2)
GetCollectionsAsync(String, String, CancellationToken)	Get all collections (V2)
GetCosmosDbAccountsAsync(CancellationToken)	Get Cosmos DB accounts
GetDatabasesAsync(String, CancellationToken)	Get all databases (V2)
GetDocumentAsync(String, String, String, String, Nullable<Boolean>, String, CancellationToken)	Get a document (V2)
GetDocumentsAsync(String, String, String, Nullable<Boolean>, String, CancellationToken)	Get all documents (V3)
GetStoredProceduresAsync(String, String, String, CancellationToken)	Get stored procedures (V2)
QueryDocumentsAsync(String, String, String, String, String, Nullable<Int32>, String, String, String, Nullable<Boolean>, String, CancellationToken)	Query documents V5
ReplaceDocumentAsync(String, String, String, String, PutDocumentRequest, CancellationToken)	Replace a document (V2)
ReplaceStoredProcedureAsync(String, String, String, String, ReplaceStoredProcedureInput, CancellationToken)	Replace stored procedure (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)