Class CosmosDbLinkedService

Microsoft Azure Cosmos Database (CosmosDB) linked service.

Inheritance
System.Object
LinkedService
CosmosDbLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CosmosDbLinkedService/CosmosDbLinkedServiceConverter))]
public class CosmosDbLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

CosmosDbLinkedService()

Initializes a new instance of CosmosDbLinkedService.

Declaration
public CosmosDbLinkedService ();

Properties

AccountEndpoint

The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).

Declaration
public object AccountEndpoint { get; set; }
Property Value
System.Object

AccountKey

The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase AccountKey { get; set; }
Property Value
SecretBase

ConnectionString

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Declaration
public object ConnectionString { get; set; }
Property Value
System.Object

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

Database

The name of the database. Type: string (or Expression with resultType string).

Declaration
public object Database { get; set; }
Property Value
System.Object

EncryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object