CosmosDbLinkedService interface

Package:

@azure/arm-datafactory

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.
azureCloudType	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).
connectionMode	The connection mode used to access CosmosDB account. Type: string.
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.
servicePrincipalCredential	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.
servicePrincipalCredentialType	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string.
servicePrincipalId	The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
tenant	The name or ID of the tenant to which the service principal belongs. 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.

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

azureCloudType

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).

azureCloudType?: any

Property Value

any

connectionMode

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

connectionMode?: string

Property Value

string

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.

encryptedCredential?: string

Property Value

string

servicePrincipalCredential

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.

servicePrincipalCredential?: SecretBaseUnion

Property Value

SecretBaseUnion

servicePrincipalCredentialType

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

servicePrincipalCredentialType?: any

Property Value

any

servicePrincipalId

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

servicePrincipalId?: any

Property Value

any

tenant

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

tenant?: 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