RestServiceLinkedService interface

Pacote:

@azure/synapse-artifacts

Serviço Rest vinculado.

Extends

LinkedService

Propriedades

aadResourceId	O recurso que você está solicitando autorização para usar.
authenticationType	Tipo de autenticação usada para se conectar ao serviço REST.
authHeaders	Os cabeçalhos HTTP adicionais na solicitação à API RESTful usada para autorização. Tipo: objeto (ou Expressão com objeto resultType).
azureCloudType	Indica o tipo de nuvem do azure da autenticação de princípio de serviço. Os valores permitidos são AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. O valor padrão é o tipo de nuvem das regiões do data factory. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
clientId	A ID do cliente associada ao aplicativo. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
clientSecret	O segredo do cliente associado ao aplicativo.
credential	A referência de credencial que contém informações de autenticação.
enableServerCertificateValidation	Se o certificado SSL do lado do servidor deve ser validado ao se conectar ao ponto de extremidade. O valor padrão é true. Tipo: booliano (ou Expressão com resultType booleano).
encryptedCredential	A credencial criptografada usada para autenticação. As credenciais são criptografadas usando o gerenciador de credenciais do integration runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
password	A senha usada no tipo de autenticação Básica.
resource	O serviço de destino ou o recurso ao qual o acesso será solicitado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
scope	O escopo do acesso necessário. Ele descreve que tipo de acesso será solicitado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
servicePrincipalCredentialType	O tipo de credencial da entidade de serviço a ser usado na autenticação server-To-Server. 'ServicePrincipalKey' para chave/segredo, 'ServicePrincipalCert' para certificado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
servicePrincipalEmbeddedCert	Especifique o certificado codificado em base64 do aplicativo registrado no Azure Active Directory. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
servicePrincipalEmbeddedCertPassword	Especifique a senha do certificado se o certificado tiver uma senha e você estiver usando a autenticação AadServicePrincipal. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
servicePrincipalId	A ID do cliente do aplicativo usada no tipo de autenticação AadServicePrincipal.
servicePrincipalKey	A chave do aplicativo usada no tipo de autenticação AadServicePrincipal.
tenant	As informações de locatário (nome de domínio ou ID de locatário) usadas no tipo de autenticação AadServicePrincipal no qual seu aplicativo reside.
tokenEndpoint	O ponto de extremidade de token do servidor de autorização para adquirir o token de acesso. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
type	Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser
url	A URL base do serviço REST.
userName	O nome de usuário usado no tipo de autenticação Básica.

Propriedades herdadas

annotations	Lista de marcas que podem ser usadas para descrever o serviço vinculado.
connectVia	A referência de runtime de integração.
description	Descrição do serviço vinculado.
parameters	Parâmetros para o serviço vinculado.
version	Versão do serviço vinculado.

Detalhes da propriedade

aadResourceId

O recurso que você está solicitando autorização para usar.

aadResourceId?: any

Valor da propriedade

any

authenticationType

Tipo de autenticação usada para se conectar ao serviço REST.

authenticationType: string

Valor da propriedade

string

authHeaders

Os cabeçalhos HTTP adicionais na solicitação à API RESTful usada para autorização. Tipo: objeto (ou Expressão com objeto resultType).

authHeaders?: any

Valor da propriedade

any

azureCloudType

Indica o tipo de nuvem do azure da autenticação de princípio de serviço. Os valores permitidos são AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. O valor padrão é o tipo de nuvem das regiões do data factory. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

azureCloudType?: any

Valor da propriedade

any

clientId

A ID do cliente associada ao aplicativo. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

clientId?: any

Valor da propriedade

any

clientSecret

O segredo do cliente associado ao aplicativo.

clientSecret?: SecretBaseUnion

Valor da propriedade

SecretBaseUnion

credential

A referência de credencial que contém informações de autenticação.

credential?: CredentialReference

Valor da propriedade

CredentialReference

enableServerCertificateValidation

Se o certificado SSL do lado do servidor deve ser validado ao se conectar ao ponto de extremidade. O valor padrão é true. Tipo: booliano (ou Expressão com resultType booleano).

enableServerCertificateValidation?: any

Valor da propriedade

any

encryptedCredential

A credencial criptografada usada para autenticação. As credenciais são criptografadas usando o gerenciador de credenciais do integration runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

encryptedCredential?: any

Valor da propriedade

any

password

A senha usada no tipo de autenticação Básica.

password?: SecretBaseUnion

Valor da propriedade

SecretBaseUnion

resource

O serviço de destino ou o recurso ao qual o acesso será solicitado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

resource?: any

Valor da propriedade

any

scope

O escopo do acesso necessário. Ele descreve que tipo de acesso será solicitado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

scope?: any

Valor da propriedade

any

servicePrincipalCredentialType

O tipo de credencial da entidade de serviço a ser usado na autenticação server-To-Server. 'ServicePrincipalKey' para chave/segredo, 'ServicePrincipalCert' para certificado. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

servicePrincipalCredentialType?: any

Valor da propriedade

any

servicePrincipalEmbeddedCert

Especifique o certificado codificado em base64 do aplicativo registrado no Azure Active Directory. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

servicePrincipalEmbeddedCert?: SecretBaseUnion

Valor da propriedade

SecretBaseUnion

servicePrincipalEmbeddedCertPassword

Especifique a senha do certificado se o certificado tiver uma senha e você estiver usando a autenticação AadServicePrincipal. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

Valor da propriedade

SecretBaseUnion

servicePrincipalId

A ID do cliente do aplicativo usada no tipo de autenticação AadServicePrincipal.

servicePrincipalId?: any

Valor da propriedade

any

servicePrincipalKey

A chave do aplicativo usada no tipo de autenticação AadServicePrincipal.

servicePrincipalKey?: SecretBaseUnion

Valor da propriedade

SecretBaseUnion

tenant

As informações de locatário (nome de domínio ou ID de locatário) usadas no tipo de autenticação AadServicePrincipal no qual seu aplicativo reside.

tenant?: any

Valor da propriedade

any

tokenEndpoint

O ponto de extremidade de token do servidor de autorização para adquirir o token de acesso. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

tokenEndpoint?: any

Valor da propriedade

any

type

Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser

type: "RestService"

Valor da propriedade

"RestService"

url

A URL base do serviço REST.

url: any

Valor da propriedade

any

userName

O nome de usuário usado no tipo de autenticação Básica.

userName?: any

Valor da propriedade

any

Detalhes das propriedades herdadas

annotations

Lista de marcas que podem ser usadas para descrever o serviço vinculado.

annotations?: any[]

Valor da propriedade

any[]

herdado deLinkedService.annotations

connectVia

A referência de runtime de integração.

connectVia?: IntegrationRuntimeReference

Valor da propriedade

IntegrationRuntimeReference

herdado deLinkedService.connectVia

description

Descrição do serviço vinculado.

description?: string

Valor da propriedade

string

herdado deLinkedService.description

parameters

Parâmetros para o serviço vinculado.

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

Valor da propriedade

{[propertyName: string]: ParameterSpecification}

herdado deLinkedService.parameters

version

Versão do serviço vinculado.

version?: string

Valor da propriedade

string

herdado doLinkedService.version