你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

AzureSqlDWLinkedService interface

Azure SQL 数据仓库链接服务。

扩展

属性

applicationIntent

连接到服务器时的应用程序工作负荷类型,由建议的版本使用。 可能的值为 ReadOnly 和 ReadWrite。 类型:字符串(或带有 resultType 字符串的表达式)。

authenticationType

用于身份验证的类型。 类型:字符串。

azureCloudType

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

commandTimeout

在终止尝试执行命令并生成错误之前(以秒为单位)的默认等待时间(以秒为单位),由建议的版本使用。 类型:整数(或包含 resultType 整数的表达式)。

connectionString

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

connectRetryCount

确定有空闲连接失败(由建议的版本使用)后尝试的重新连接数。 这必须是介于 0 和 255 之间的整数。 类型:整数(或包含 resultType 整数的表达式)。

connectRetryInterval

确定建议的版本使用空闲连接失败后,每个重新连接尝试之间的时间(以秒为单位)。 这必须是介于 1 和 60 之间的整数。 类型:整数(或包含 resultType 整数的表达式)。

connectTimeout

在终止尝试并生成由建议版本使用的错误之前,等待与服务器的连接的时间长度(以秒为单位)。 类型:整数(或包含 resultType 整数的表达式)。

credential

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

database

建议的版本使用的数据库的名称。 类型:字符串(或带有 resultType 字符串的表达式)。

encrypt

指示客户端和服务器之间发送的所有数据是否需要 TLS 加密(由建议的版本使用)。 可能的值为 true/yes/mandatory、false/no/optional 和 strict。 类型:字符串(或带有 resultType 字符串的表达式)。

encryptedCredential

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

failoverPartner

如果主服务器关闭(由建议的版本使用)连接到的伙伴服务器的名称或地址。 类型:字符串(或带有 resultType 字符串的表达式)。

hostNameInCertificate

验证连接的服务器证书时要使用的主机名。 如果未指定,则数据源中的服务器名称用于证书验证,由建议的版本使用。 类型:字符串(或带有 resultType 字符串的表达式)。

integratedSecurity

指示是否在连接(如果为 false)中指定用户 ID 和密码,或者当前 Windows 帐户凭据是否用于身份验证(如果为 true),由建议的版本使用。 类型:布尔值(或带有 resultType 布尔值的表达式)。

loadBalanceTimeout

在被建议的版本使用之前,连接在连接池中生存的最短时间(以秒为单位)。 类型:整数(或包含 resultType 整数的表达式)。

maxPoolSize

此特定连接字符串的连接池中允许的最大连接数,由建议的版本使用。 类型:整数(或包含 resultType 整数的表达式)。

minPoolSize

此特定连接字符串的连接池中允许的最小连接数,由建议的版本使用。 类型:整数(或包含 resultType 整数的表达式)。

multipleActiveResultSets

如果为 true,应用程序可以维护多个活动结果集(MARS)。 如果为 false,应用程序必须处理或取消一个批处理中的所有结果集,然后才能在该连接上执行任何其他批处理(由建议的版本使用)。 类型:布尔值(或带有 resultType 布尔值的表达式)。

multiSubnetFailover

如果应用程序连接到不同子网上的 AlwaysOn 可用性组(AG),则设置 MultiSubnetFailover=true 可以更快地检测和连接到(当前)活动服务器(当前)活动服务器(由建议的版本使用)。 类型:布尔值(或带有 resultType 布尔值的表达式)。

packetSize

用于与服务器实例通信的网络数据包的大小(以字节为单位,由建议的版本使用)。 类型:整数(或包含 resultType 整数的表达式)。

password

连接字符串中密码的 Azure Key Vault 机密引用。

pooling

指示每次请求连接时,连接是共用的还是显式打开的,由建议的版本使用。 类型:布尔值(或带有 resultType 布尔值的表达式)。

server

要连接到的 SQL Server 实例的名称或网络地址,由建议的版本使用。 类型:字符串(或带有 resultType 字符串的表达式)。

servicePrincipalCredential

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

servicePrincipalCredentialType

在服务器To-Server 身份验证中使用的服务主体凭据类型。 密钥/机密的“ServicePrincipalKey”,证书的“ServicePrincipalCert”。 类型:字符串(或带有 resultType 字符串的表达式)。

servicePrincipalId

用于对 Azure SQL 数据仓库进行身份验证的服务主体的 ID。 类型:字符串(或带有 resultType 字符串的表达式)。

servicePrincipalKey

用于对 Azure SQL 数据仓库进行身份验证的服务主体的密钥。

tenant

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

trustServerCertificate

指示通道是否在绕过证书链来验证推荐版本使用的信任时是否加密通道。 类型:布尔值(或带有 resultType 布尔值的表达式)。

type

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

userName

连接到服务器时要使用的用户名。 类型:字符串(或带有 resultType 字符串的表达式)。

继承属性

annotations

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

connectVia

集成运行时参考。

description

链接服务说明。

parameters

链接服务的参数。

version

链接服务的版本。

属性详细信息

applicationIntent

连接到服务器时的应用程序工作负荷类型,由建议的版本使用。 可能的值为 ReadOnly 和 ReadWrite。 类型:字符串(或带有 resultType 字符串的表达式)。

applicationIntent?: any

属性值

any

authenticationType

用于身份验证的类型。 类型:字符串。

authenticationType?: string

属性值

string

azureCloudType

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

azureCloudType?: any

属性值

any

commandTimeout

在终止尝试执行命令并生成错误之前(以秒为单位)的默认等待时间(以秒为单位),由建议的版本使用。 类型:整数(或包含 resultType 整数的表达式)。

commandTimeout?: any

属性值

any

connectionString

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

connectionString?: any

属性值

any

connectRetryCount

确定有空闲连接失败(由建议的版本使用)后尝试的重新连接数。 这必须是介于 0 和 255 之间的整数。 类型:整数(或包含 resultType 整数的表达式)。

connectRetryCount?: any

属性值

any

connectRetryInterval

确定建议的版本使用空闲连接失败后,每个重新连接尝试之间的时间(以秒为单位)。 这必须是介于 1 和 60 之间的整数。 类型:整数(或包含 resultType 整数的表达式)。

connectRetryInterval?: any

属性值

any

connectTimeout

在终止尝试并生成由建议版本使用的错误之前,等待与服务器的连接的时间长度(以秒为单位)。 类型:整数(或包含 resultType 整数的表达式)。

connectTimeout?: any

属性值

any

credential

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

credential?: CredentialReference

属性值

database

建议的版本使用的数据库的名称。 类型:字符串(或带有 resultType 字符串的表达式)。

database?: any

属性值

any

encrypt

指示客户端和服务器之间发送的所有数据是否需要 TLS 加密(由建议的版本使用)。 可能的值为 true/yes/mandatory、false/no/optional 和 strict。 类型:字符串(或带有 resultType 字符串的表达式)。

encrypt?: any

属性值

any

encryptedCredential

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

encryptedCredential?: string

属性值

string

failoverPartner

如果主服务器关闭(由建议的版本使用)连接到的伙伴服务器的名称或地址。 类型:字符串(或带有 resultType 字符串的表达式)。

failoverPartner?: any

属性值

any

hostNameInCertificate

验证连接的服务器证书时要使用的主机名。 如果未指定,则数据源中的服务器名称用于证书验证,由建议的版本使用。 类型:字符串(或带有 resultType 字符串的表达式)。

hostNameInCertificate?: any

属性值

any

integratedSecurity

指示是否在连接(如果为 false)中指定用户 ID 和密码,或者当前 Windows 帐户凭据是否用于身份验证(如果为 true),由建议的版本使用。 类型:布尔值(或带有 resultType 布尔值的表达式)。

integratedSecurity?: any

属性值

any

loadBalanceTimeout

在被建议的版本使用之前,连接在连接池中生存的最短时间(以秒为单位)。 类型:整数(或包含 resultType 整数的表达式)。

loadBalanceTimeout?: any

属性值

any

maxPoolSize

此特定连接字符串的连接池中允许的最大连接数,由建议的版本使用。 类型:整数(或包含 resultType 整数的表达式)。

maxPoolSize?: any

属性值

any

minPoolSize

此特定连接字符串的连接池中允许的最小连接数,由建议的版本使用。 类型:整数(或包含 resultType 整数的表达式)。

minPoolSize?: any

属性值

any

multipleActiveResultSets

如果为 true,应用程序可以维护多个活动结果集(MARS)。 如果为 false,应用程序必须处理或取消一个批处理中的所有结果集,然后才能在该连接上执行任何其他批处理(由建议的版本使用)。 类型:布尔值(或带有 resultType 布尔值的表达式)。

multipleActiveResultSets?: any

属性值

any

multiSubnetFailover

如果应用程序连接到不同子网上的 AlwaysOn 可用性组(AG),则设置 MultiSubnetFailover=true 可以更快地检测和连接到(当前)活动服务器(当前)活动服务器(由建议的版本使用)。 类型:布尔值(或带有 resultType 布尔值的表达式)。

multiSubnetFailover?: any

属性值

any

packetSize

用于与服务器实例通信的网络数据包的大小(以字节为单位,由建议的版本使用)。 类型:整数(或包含 resultType 整数的表达式)。

packetSize?: any

属性值

any

password

连接字符串中密码的 Azure Key Vault 机密引用。

password?: AzureKeyVaultSecretReference

属性值

pooling

指示每次请求连接时,连接是共用的还是显式打开的,由建议的版本使用。 类型:布尔值(或带有 resultType 布尔值的表达式)。

pooling?: any

属性值

any

server

要连接到的 SQL Server 实例的名称或网络地址,由建议的版本使用。 类型:字符串(或带有 resultType 字符串的表达式)。

server?: any

属性值

any

servicePrincipalCredential

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

servicePrincipalCredential?: SecretBaseUnion

属性值

servicePrincipalCredentialType

在服务器To-Server 身份验证中使用的服务主体凭据类型。 密钥/机密的“ServicePrincipalKey”,证书的“ServicePrincipalCert”。 类型:字符串(或带有 resultType 字符串的表达式)。

servicePrincipalCredentialType?: any

属性值

any

servicePrincipalId

用于对 Azure SQL 数据仓库进行身份验证的服务主体的 ID。 类型:字符串(或带有 resultType 字符串的表达式)。

servicePrincipalId?: any

属性值

any

servicePrincipalKey

用于对 Azure SQL 数据仓库进行身份验证的服务主体的密钥。

servicePrincipalKey?: SecretBaseUnion

属性值

tenant

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

tenant?: any

属性值

any

trustServerCertificate

指示通道是否在绕过证书链来验证推荐版本使用的信任时是否加密通道。 类型:布尔值(或带有 resultType 布尔值的表达式)。

trustServerCertificate?: any

属性值

any

type

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

type: "AzureSqlDW"

属性值

"AzureSqlDW"

userName

连接到服务器时要使用的用户名。 类型:字符串(或带有 resultType 字符串的表达式)。

userName?: any

属性值

any

继承属性详细信息

annotations

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

annotations?: any[]

属性值

any[]

继承自LinkedService.annotations

connectVia

集成运行时参考。

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