HttpLinkedService Class

Definition

Linked service for an HTTP source.

public class HttpLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.HttpLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.HttpLinkedService>
public class HttpLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties
type HttpLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<HttpLinkedService>
    interface IPersistableModel<HttpLinkedService>
type HttpLinkedService = class
    inherit DataFactoryLinkedServiceProperties
Public Class HttpLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of HttpLinkedService), IPersistableModel(Of HttpLinkedService)
Public Class HttpLinkedService
Inherits DataFactoryLinkedServiceProperties
Inheritance
Implements

Constructors

HttpLinkedService(DataFactoryElement<String>)

Initializes a new instance of HttpLinkedService.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryLinkedServiceProperties)
Annotations

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

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from DataFactoryLinkedServiceProperties)
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).

ConnectVia

The integration runtime reference.

(Inherited from DataFactoryLinkedServiceProperties)
Description

Linked service description.

(Inherited from DataFactoryLinkedServiceProperties)
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.

LinkedServiceVersion

Version of the linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Parameters

Parameters for linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Password

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

Uri

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from DataFactoryLinkedServiceProperties)

Explicit Interface Implementations

IJsonModel<DataFactoryLinkedServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<DataFactoryLinkedServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<HttpLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<HttpLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataFactoryLinkedServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<HttpLinkedService>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<HttpLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<HttpLinkedService>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to