AzureSqlDatabaseLinkedService Class

Definition

Microsoft Azure SQL Database linked service.

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

Constructors

AzureSqlDatabaseLinkedService(DataFactoryElement<String>)

Initializes a new instance of AzureSqlDatabaseLinkedService.

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

Sql always encrypted properties.

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

Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

ConnectionString

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

ConnectVia

The integration runtime reference.

(Inherited from DataFactoryLinkedServiceProperties)
Credential

The credential reference containing authentication information.

Description

Linked service description.

(Inherited from DataFactoryLinkedServiceProperties)
EncryptedCredential

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

Parameters

Parameters for linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Password

The Azure key vault secret reference of password in connection string.

ServicePrincipalId

The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).

ServicePrincipalKey

The key of the service principal used to authenticate against Azure SQL Database.

Tenant

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Explicit Interface Implementations

IJsonModel<AzureSqlDatabaseLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<AzureSqlDatabaseLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

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)
IPersistableModel<AzureSqlDatabaseLinkedService>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureSqlDatabaseLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<AzureSqlDatabaseLinkedService>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

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)

Applies to