Share via

CosmosDbLinkedService Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
CosmosDbLinkedService.cs

Microsoft Azure Cosmos Database (CosmosDB) linked service.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CosmosDbLinkedService+CosmosDbLinkedServiceConverter))]
public class CosmosDbLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.CosmosDbLinkedService+CosmosDbLinkedServiceConverter))>]
type CosmosDbLinkedService = class
    inherit LinkedService
Public Class CosmosDbLinkedService
Inherits LinkedService
Inheritance
Object
LinkedService
CosmosDbLinkedService
Attributes
JsonConverterAttribute

Constructors

CosmosDbLinkedService()

Initializes a new instance of CosmosDbLinkedService.

Properties

AccountEndpoint

The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).
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.
AdditionalProperties

Additional Properties.

(Inherited from LinkedService)
Annotations

List of tags that can be used for describing the linked service.

(Inherited from LinkedService)
ConnectionString

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

The integration runtime reference.

(Inherited from LinkedService)
Credential

The credential reference containing authentication information.
Database

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

Linked service description.

(Inherited from LinkedService)
EncryptedCredential

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

Parameters for linked service.

(Inherited from LinkedService)

Applies to