Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RestServiceLinkedService

Package version

Rest Service linked service.

Hierarchy

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional aadResourceId

aadResourceId: any

The resource you are requesting authorization to use.

Optional annotations

annotations: any[]

List of tags that can be used for describing the linked service.

authenticationType

authenticationType: RestServiceAuthenticationType

Type of authentication used to connect to the REST service.

Optional azureCloudType

azureCloudType: any

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

Optional clientId

clientId: any

The client ID associated with your application. Type: string (or Expression with resultType string).

Optional clientSecret

clientSecret: SecretBaseUnion

The client secret associated with your application.

Optional connectVia

The integration runtime reference.

Optional description

description: undefined | string

Linked service description.

Optional enableServerCertificateValidation

enableServerCertificateValidation: any

Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).

Optional encryptedCredential

encryptedCredential: any

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | {}

Parameters for linked service.

Optional password

password: SecretBaseUnion

The password used in Basic authentication type.

Optional resource

resource: any

The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).

Optional scope

scope: any

The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).

Optional servicePrincipalId

servicePrincipalId: any

The application's client ID used in AadServicePrincipal authentication type.

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion

The application's key used in AadServicePrincipal authentication type.

Optional tenant

tenant: any

The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.

Optional tokenEndpoint

tokenEndpoint: any

The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).

type

type: "RestService"

Polymorphic discriminator, which specifies the different types this object can be

url

url: any

The base URL of the REST service.

Optional userName

userName: any

The user name used in Basic authentication type.

Generated using TypeDoc