Share via

HttpLinkedService interface

  • Reference
Package:
@azure/arm-datafactory

Linked service for an HTTP source.

Extends
LinkedService

Properties

authenticationType

The authentication type to be used to connect to the HTTP server.
authHeaders

The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
certThumbprint

Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
embeddedCertData

Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).
enableServerCertificateValidation

If true, validate the HTTPS server SSL certificate. 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

Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.
type

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

The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string).
userName

User name for Basic, Digest, or Windows authentication. 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

authenticationType

The authentication type to be used to connect to the HTTP server.

authenticationType?: string

Property Value

string

authHeaders

The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).

authHeaders?: any

Property Value

any

certThumbprint

Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

certThumbprint?: any

Property Value

any

embeddedCertData

Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

embeddedCertData?: any

Property Value

any

enableServerCertificateValidation

If true, validate the HTTPS server SSL certificate. 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

Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.

password?: SecretBaseUnion

Property Value

SecretBaseUnion

type

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

type: "HttpServer"

Property Value

"HttpServer"

url

The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string).

url: any

Property Value

any

userName

User name for Basic, Digest, or Windows authentication. 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