Package version:

Interface HttpLinkedService

Linked service for an HTTP source.

interface HttpLinkedService {
    annotations?: any[];
    authenticationType?: string;
    authHeaders?: any;
    certThumbprint?: any;
    connectVia?: IntegrationRuntimeReference;
    description?: string;
    embeddedCertData?: any;
    enableServerCertificateValidation?: any;
    encryptedCredential?: string;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    password?: SecretBaseUnion;
    type: "HttpServer";
    url: any;
    userName?: any;
    version?: string;
}

Hierarchy (view full)

Properties

annotations?: any[]

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

authenticationType?: string

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

authHeaders?: any

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

certThumbprint?: any

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

The integration runtime reference.

description?: string

Linked service description.

embeddedCertData?: any

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?: any

If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).

encryptedCredential?: string

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

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

Parameters for linked service.

password?: SecretBaseUnion

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

type

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

url: any

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

userName?: any

User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).

version?: string

Version of the linked service.