CosmosDbLinkedService interface

Package:

@azure/synapse-artifacts

Microsoft Azure Cosmos Database (CosmosDB) linked service.

Extends

LinkedService

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.
connectionString	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
credential	The credential reference containing authentication information.
database	The name of the database. Type: string (or Expression with resultType string)
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
type	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

annotations	List of tags that can be used for describing the linked service.
connectVia	The integration runtime reference.
description	Linked service description.
parameters	Parameters for linked service.
version	Version of the linked service.

Property Details

accountEndpoint

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

accountEndpoint?: any

Property Value

any

accountKey

The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.

accountKey?: SecretBaseUnion

Property Value

SecretBaseUnion

connectionString

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

connectionString?: any

Property Value

any

credential

The credential reference containing authentication information.

credential?: CredentialReference

Property Value

CredentialReference

database

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

database?: any

Property Value

any

encryptedCredential

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

encryptedCredential?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "CosmosDb"

Property Value

"CosmosDb"

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version