Package version:

Interface CosmosDbMongoDbApiLinkedService

Linked service for CosmosDB (MongoDB API) data source.

interface CosmosDbMongoDbApiLinkedService {
    annotations?: any[];
    connectionString: any;
    connectVia?: IntegrationRuntimeReference;
    database: any;
    description?: string;
    isServerVersionAbove32?: any;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    type: "CosmosDbMongoDbApi";
    version?: string;
}

Hierarchy (view full)

Properties

annotations? connectionString connectVia? database description? isServerVersionAbove32? parameters? type version?

Properties

Optionalannotations

annotations?: any[]

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

connectionString

connectionString: any

The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

database

database: any

The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).

Optionaldescription

description?: string

Linked service description.

OptionalisServerVersionAbove32

isServerVersionAbove32?: any

Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).

Optionalparameters

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

Parameters for linked service.

type

type

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

Optionalversion

version?: string

Version of the linked service.

Settings

Member Visibility