AzureSynapseArtifactsLinkedService Class

Definition

Azure Synapse Analytics (Artifacts) linked service.

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

Constructors

AzureSynapseArtifactsLinkedService(DataFactoryElement<String>)

Initializes a new instance of AzureSynapseArtifactsLinkedService.

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

Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string).

ConnectVia

The integration runtime reference.

(Inherited from DataFactoryLinkedServiceProperties)
Description

Linked service description.

(Inherited from DataFactoryLinkedServiceProperties)
Endpoint

https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string).

Parameters

Parameters for linked service.

(Inherited from DataFactoryLinkedServiceProperties)
WorkspaceResourceId

The resource ID of the Synapse workspace. The format should be: /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}. Type: string (or Expression with resultType string).

Explicit Interface Implementations

IJsonModel<AzureSynapseArtifactsLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<AzureSynapseArtifactsLinkedService>.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<AzureSynapseArtifactsLinkedService>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureSynapseArtifactsLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<AzureSynapseArtifactsLinkedService>.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