RestServiceLinkedService interface

包:

@azure/synapse-artifacts

Rest 服务链接服务。

扩展

LinkedService

属性

aadResourceId	请求使用授权的资源。
authenticationType	用于连接到 REST 服务的身份验证类型。
authHeaders	请求中用于授权的 RESTful API 中的其他 HTTP 标头。 类型：对象（或带有 resultType 对象的表达式）。
azureCloudType	指示服务主体身份验证的 Azure 云类型。允许的值为 AzurePublic、AzureChina、AzureUsGovernment、AzureGermany。 默认值为数据工厂区域的云类型。 类型：字符串（或带有 resultType 字符串的表达式）。
clientId	与应用程序关联的客户端 ID。 类型：字符串（或带有 resultType 字符串的表达式）。
clientSecret	与应用程序关联的客户端密码。
credential	包含身份验证信息的凭据引用。
enableServerCertificateValidation	是否在连接到终结点时验证服务器端 SSL 证书。默认值为 true。 类型：布尔值（或带有 resultType 布尔值的表达式）。
encryptedCredential	用于身份验证的加密凭据。 凭据使用集成运行时凭据管理器进行加密。 类型：字符串（或带有 resultType 字符串的表达式）。
password	基本身份验证类型中使用的密码。
resource	将向其请求访问权限的目标服务或资源。 类型：字符串（或带有 resultType 字符串的表达式）。
scope	所需的访问范围。 它描述将请求哪种类型的访问。 类型：字符串（或带有 resultType 字符串的表达式）。
servicePrincipalCredentialType	在服务器To-Server 身份验证中使用的服务主体凭据类型。 密钥/机密的“ServicePrincipalKey”，证书的“ServicePrincipalCert”。 类型：字符串（或带有 resultType 字符串的表达式）。
servicePrincipalEmbeddedCert	指定在 Azure Active Directory 中注册的应用程序的 base64 编码证书。 类型：字符串（或带有 resultType 字符串的表达式）。
servicePrincipalEmbeddedCertPassword	如果证书具有密码，并且使用的是 AadServicePrincipal 身份验证，请指定证书的密码。 类型：字符串（或带有 resultType 字符串的表达式）。
servicePrincipalId	AadServicePrincipal 身份验证类型中使用的应用程序的客户端 ID。
servicePrincipalKey	AadServicePrincipal 身份验证类型中使用的应用程序的密钥。
tenant	应用程序所在的 AadServicePrincipal 身份验证类型中使用的租户信息（域名或租户 ID）。
tokenEndpoint	要获取访问令牌的授权服务器的令牌终结点。 类型：字符串（或带有 resultType 字符串的表达式）。
type	多态鉴别器，它指定此对象可以的不同类型的
url	REST 服务的基 URL。
userName	基本身份验证类型中使用的用户名。

继承属性

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

属性详细信息

aadResourceId

请求使用授权的资源。

aadResourceId?: any

属性值

any

authenticationType

用于连接到 REST 服务的身份验证类型。

authenticationType: string

属性值

string

authHeaders

请求中用于授权的 RESTful API 中的其他 HTTP 标头。 类型：对象（或带有 resultType 对象的表达式）。

authHeaders?: any

属性值

any

azureCloudType

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

azureCloudType?: any

属性值

any

clientId

与应用程序关联的客户端 ID。 类型：字符串（或带有 resultType 字符串的表达式）。

clientId?: any

属性值

any

clientSecret

与应用程序关联的客户端密码。

clientSecret?: SecretBaseUnion

属性值

SecretBaseUnion

credential

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

credential?: CredentialReference

属性值

CredentialReference

enableServerCertificateValidation

是否在连接到终结点时验证服务器端 SSL 证书。默认值为 true。 类型：布尔值（或带有 resultType 布尔值的表达式）。

enableServerCertificateValidation?: any

属性值

any

encryptedCredential

用于身份验证的加密凭据。 凭据使用集成运行时凭据管理器进行加密。 类型：字符串（或带有 resultType 字符串的表达式）。

encryptedCredential?: any

属性值

any

password

基本身份验证类型中使用的密码。

password?: SecretBaseUnion

属性值

SecretBaseUnion

resource

将向其请求访问权限的目标服务或资源。 类型：字符串（或带有 resultType 字符串的表达式）。

resource?: any

属性值

any

scope

所需的访问范围。 它描述将请求哪种类型的访问。 类型：字符串（或带有 resultType 字符串的表达式）。

scope?: any

属性值

any

servicePrincipalCredentialType

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

servicePrincipalCredentialType?: any

属性值

any

servicePrincipalEmbeddedCert

指定在 Azure Active Directory 中注册的应用程序的 base64 编码证书。 类型：字符串（或带有 resultType 字符串的表达式）。

servicePrincipalEmbeddedCert?: SecretBaseUnion

属性值

SecretBaseUnion

servicePrincipalEmbeddedCertPassword

如果证书具有密码，并且使用的是 AadServicePrincipal 身份验证，请指定证书的密码。 类型：字符串（或带有 resultType 字符串的表达式）。

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

属性值

SecretBaseUnion

servicePrincipalId

AadServicePrincipal 身份验证类型中使用的应用程序的客户端 ID。

servicePrincipalId?: any

属性值

any

servicePrincipalKey

AadServicePrincipal 身份验证类型中使用的应用程序的密钥。

servicePrincipalKey?: SecretBaseUnion

属性值

SecretBaseUnion

tenant

应用程序所在的 AadServicePrincipal 身份验证类型中使用的租户信息（域名或租户 ID）。

tenant?: any

属性值

any

tokenEndpoint

要获取访问令牌的授权服务器的令牌终结点。 类型：字符串（或带有 resultType 字符串的表达式）。

tokenEndpoint?: any

属性值

any

type

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

type: "RestService"

属性值

"RestService"

url

REST 服务的基 URL。

url: any

属性值

any

userName

基本身份验证类型中使用的用户名。

userName?: any

属性值

any

继承属性详细信息

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