Package version:

Interface CosmosDbLinkedService

Microsoft Azure Cosmos Database (CosmosDB) linked service.

interface CosmosDbLinkedService {
    accountEndpoint?: any;
    accountKey?: SecretBaseUnion;
    annotations?: any[];
    azureCloudType?: any;
    connectionMode?: string;
    connectionString?: any;
    connectVia?: IntegrationRuntimeReference;
    credential?: CredentialReference;
    database?: any;
    description?: string;
    encryptedCredential?: string;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    servicePrincipalCredential?: SecretBaseUnion;
    servicePrincipalCredentialType?: any;
    servicePrincipalId?: any;
    tenant?: any;
    type: "CosmosDb";
    version?: string;
}

Hierarchy (view full)

Properties

accountEndpoint? accountKey? annotations? azureCloudType? connectionMode? connectionString? connectVia? credential? database? description? encryptedCredential? parameters? servicePrincipalCredential? servicePrincipalCredentialType? servicePrincipalId? tenant? type version?

Properties

OptionalaccountEndpoint

accountEndpoint?: any

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

OptionalaccountKey

accountKey?: SecretBaseUnion

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

Optionalannotations

annotations?: any[]

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

OptionalazureCloudType

azureCloudType?: any

Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

OptionalconnectionMode

connectionMode?: string

The connection mode used to access CosmosDB account. Type: string.

OptionalconnectionString

connectionString?: any

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

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

Optionalcredential

credential?: CredentialReference

The credential reference containing authentication information.

Optionaldatabase

database?: any

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

Optionaldescription

description?: string

Linked service description.

OptionalencryptedCredential

encryptedCredential?: string

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Optionalparameters

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

Parameters for linked service.

OptionalservicePrincipalCredential

servicePrincipalCredential?: SecretBaseUnion

The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.

OptionalservicePrincipalCredentialType

servicePrincipalCredentialType?: any

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string.

OptionalservicePrincipalId

servicePrincipalId?: any

The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

Optionaltenant

tenant?: any

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

type

type

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

Optionalversion

version?: string

Version of the linked service.

Settings

Member Visibility