HttpLinkedService Class

Linked service for an HTTP source.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.synapse.artifacts.models._models_py3.LinkedService

HttpLinkedService

Constructor

HttpLinkedService(*, url: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.HttpAuthenticationType]] = None, user_name: Optional[object] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, embedded_cert_data: Optional[object] = None, cert_thumbprint: Optional[object] = None, encrypted_credential: Optional[object] = None, enable_server_certificate_validation: Optional[object] = None, **kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

type

str

Required

Required. Type of linked service.Constant filled by server.

connect_via

IntegrationRuntimeReference

Required

The integration runtime reference.

description

str

Required

Linked service description.

parameters

dict[str, ParameterSpecification]

Required

Parameters for linked service.

annotations

list[object]

Required

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

url

object

Required

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

authentication_type

str or HttpAuthenticationType

Required

The authentication type to be used to connect to the HTTP server. Possible values include: "Basic", "Anonymous", "Digest", "Windows", "ClientCertificate".

user_name

object

Required

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

password

SecretBase

Required

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

embedded_cert_data

object

Required

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

cert_thumbprint

object

Required

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

encrypted_credential

object

Required

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

enable_server_certificate_validation

object

Required

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