Share via

RestServiceLinkedService interface

  • Reference
Package:
@azure/arm-datafactory

Rest Service linked service.

Extends
LinkedService

Properties

aadResourceId

The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
authenticationType

Type of authentication used to connect to the REST service.
authHeaders

The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
azureCloudType

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

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

The client secret associated with your application.
credential

The credential reference containing authentication information.
enableServerCertificateValidation

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

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
password

The password used in Basic authentication type.
resource

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

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

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
servicePrincipalEmbeddedCert

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
servicePrincipalEmbeddedCertPassword

Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
servicePrincipalId

The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
servicePrincipalKey

The application's key used in AadServicePrincipal authentication type.
tenant

The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
tokenEndpoint

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

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

The base URL of the REST service. Type: string (or Expression with resultType string).
userName

The user name used in Basic authentication type. Type: string (or Expression with resultType string).

Inherited Properties

annotations

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

The integration runtime reference.
description

Linked service description.
parameters

Parameters for linked service.
version

Version of the linked service.

Property Details

aadResourceId

The resource you are requesting authorization to use. Type: string (or Expression with resultType string).

aadResourceId?: any

Property Value

any

authenticationType

Type of authentication used to connect to the REST service.

authenticationType: string

Property Value

string

authHeaders

The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).

authHeaders?: any

Property Value

any

azureCloudType

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

azureCloudType?: any

Property Value

any

clientId

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

clientId?: any

Property Value

any

clientSecret

The client secret associated with your application.

clientSecret?: SecretBaseUnion

Property Value

SecretBaseUnion

credential

The credential reference containing authentication information.

credential?: CredentialReference

Property Value

CredentialReference

enableServerCertificateValidation

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

enableServerCertificateValidation?: any

Property Value

any

encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptedCredential?: string

Property Value

string

password

The password used in Basic authentication type.

password?: SecretBaseUnion

Property Value

SecretBaseUnion

resource

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

resource?: any

Property Value

any

scope

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

scope?: any

Property Value

any

servicePrincipalCredentialType

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).

servicePrincipalCredentialType?: any

Property Value

any

servicePrincipalEmbeddedCert

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

servicePrincipalEmbeddedCert?: SecretBaseUnion

Property Value

SecretBaseUnion

servicePrincipalEmbeddedCertPassword

Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

Property Value

SecretBaseUnion

servicePrincipalId

The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).

servicePrincipalId?: any

Property Value

any

servicePrincipalKey

The application's key used in AadServicePrincipal authentication type.

servicePrincipalKey?: SecretBaseUnion

Property Value

SecretBaseUnion

tenant

The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).

tenant?: any

Property Value

any

tokenEndpoint

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

tokenEndpoint?: any

Property Value

any

type

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

type: "RestService"

Property Value

"RestService"

url

The base URL of the REST service. Type: string (or Expression with resultType string).

url: any

Property Value

any

userName

The user name used in Basic authentication type. Type: string (or Expression with resultType string).

userName?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

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

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version