CosmosDbLinkedService interface

包:

@azure/arm-datafactory

Microsoft Azure Cosmos 数据库（CosmosDB）链接服务。

扩展

LinkedService

属性

accountEndpoint	Azure CosmosDB 帐户的终结点。 类型：字符串（或带有 resultType 字符串的表达式）
accountKey	Azure CosmosDB 帐户的帐户密钥。 类型：SecureString 或 AzureKeyVaultSecretReference。
azureCloudType	指示服务主体身份验证的 Azure 云类型。允许的值为 AzurePublic、AzureChina、AzureUsGovernment、AzureGermany。 默认值为数据工厂区域的云类型。 类型：字符串（或带有 resultType 字符串的表达式）。
connectionMode	用于访问 CosmosDB 帐户的连接模式。 类型：字符串。
connectionString	连接字符串。 类型：string、SecureString 或 AzureKeyVaultSecretReference。
credential	包含身份验证信息的凭据引用。
database	数据库的名称。 类型：字符串（或带有 resultType 字符串的表达式）
encryptedCredential	用于身份验证的加密凭据。 凭据使用集成运行时凭据管理器进行加密。 类型：字符串。
servicePrincipalCredential	Azure Active Directory 中服务主体对象的凭据。 如果 servicePrincipalCredentialType 为“ServicePrincipalKey”，servicePrincipalCredential 可以是 SecureString 或 AzureKeyVaultSecretReference。 如果 servicePrincipalCredentialType 为“ServicePrincipalCert”，servicePrincipalCredential 只能是 AzureKeyVaultSecretReference。
servicePrincipalCredentialType	在服务器To-Server 身份验证中使用的服务主体凭据类型。 密钥/机密的“ServicePrincipalKey”，证书的“ServicePrincipalCert”。 类型：字符串。
servicePrincipalId	Azure Active Directory 中用于服务器To-Server 身份验证的应用程序的客户端 ID。 类型：字符串（或带有 resultType 字符串的表达式）。
tenant	服务主体所属的租户的名称或 ID。 类型：字符串（或带有 resultType 字符串的表达式）。
type	多态鉴别器，它指定此对象可以的不同类型的

继承属性

annotations	可用于描述链接服务的标记列表。
connectVia	集成运行时参考。
description	链接服务说明。
parameters	链接服务的参数。
version	链接服务的版本。

属性详细信息

accountEndpoint

Azure CosmosDB 帐户的终结点。 类型：字符串（或带有 resultType 字符串的表达式）

accountEndpoint?: any

属性值

any

accountKey

Azure CosmosDB 帐户的帐户密钥。 类型：SecureString 或 AzureKeyVaultSecretReference。

accountKey?: SecretBaseUnion

属性值

SecretBaseUnion

azureCloudType

指示服务主体身份验证的 Azure 云类型。允许的值为 AzurePublic、AzureChina、AzureUsGovernment、AzureGermany。 默认值为数据工厂区域的云类型。 类型：字符串（或带有 resultType 字符串的表达式）。

azureCloudType?: any

属性值

any

connectionMode

用于访问 CosmosDB 帐户的连接模式。 类型：字符串。

connectionMode?: string

属性值

string

connectionString

连接字符串。 类型：string、SecureString 或 AzureKeyVaultSecretReference。

connectionString?: any

属性值

any

credential

包含身份验证信息的凭据引用。

credential?: CredentialReference

属性值

CredentialReference

database

数据库的名称。 类型：字符串（或带有 resultType 字符串的表达式）

database?: any

属性值

any

encryptedCredential

用于身份验证的加密凭据。 凭据使用集成运行时凭据管理器进行加密。 类型：字符串。

encryptedCredential?: string

属性值

string

servicePrincipalCredential

Azure Active Directory 中服务主体对象的凭据。 如果 servicePrincipalCredentialType 为“ServicePrincipalKey”，servicePrincipalCredential 可以是 SecureString 或 AzureKeyVaultSecretReference。 如果 servicePrincipalCredentialType 为“ServicePrincipalCert”，servicePrincipalCredential 只能是 AzureKeyVaultSecretReference。

servicePrincipalCredential?: SecretBaseUnion

属性值

SecretBaseUnion

servicePrincipalCredentialType

在服务器To-Server 身份验证中使用的服务主体凭据类型。 密钥/机密的“ServicePrincipalKey”，证书的“ServicePrincipalCert”。 类型：字符串。

servicePrincipalCredentialType?: any

属性值

any

servicePrincipalId

Azure Active Directory 中用于服务器To-Server 身份验证的应用程序的客户端 ID。 类型：字符串（或带有 resultType 字符串的表达式）。

servicePrincipalId?: any

属性值

any

tenant

服务主体所属的租户的名称或 ID。 类型：字符串（或带有 resultType 字符串的表达式）。

tenant?: any

属性值

any

type

多态鉴别器，它指定此对象可以的不同类型的

type: "CosmosDb"

属性值

"CosmosDb"

继承属性详细信息

annotations

可用于描述链接服务的标记列表。

annotations?: any[]

属性值

any[]

继承自LinkedService.annotations

connectVia

集成运行时参考。

connectVia?: IntegrationRuntimeReference

属性值

IntegrationRuntimeReference

继承自 LinkedService.connectVia 的

description

链接服务说明。

description?: string

属性值

string

继承自LinkedService.description

parameters

链接服务的参数。

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

属性值

{[propertyName: string]: ParameterSpecification}

继承自LinkedService.parameters

version

链接服务的版本。

version?: string

属性值

string

继承自LinkedService.version