HttpLinkedService Class

Definition

Linked service for an HTTP source.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.HttpLinkedService+HttpLinkedServiceConverter))]
public class HttpLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.HttpLinkedService+HttpLinkedServiceConverter))>]
type HttpLinkedService = class
    inherit LinkedService
Public Class HttpLinkedService
Inherits LinkedService
Inheritance
HttpLinkedService
Attributes

Constructors

HttpLinkedService(Object)

Initializes a new instance of HttpLinkedService.

Properties

AdditionalProperties

Additional Properties.

(Inherited from LinkedService)
Annotations

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

(Inherited from LinkedService)
AuthenticationType

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

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

ConnectVia

The integration runtime reference.

(Inherited from LinkedService)
Description

Linked service description.

(Inherited from LinkedService)
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 (or Expression with resultType string).

Parameters

Parameters for linked service.

(Inherited from LinkedService)
Password

Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Url

The base URL of the HTTP endpoint, e.g. http://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).

Applies to