Share via


ODataLinkedService Class

Definition

Open Data Protocol (OData) linked service.

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

Constructors

ODataLinkedService(DataFactoryElement<String>)

Initializes a new instance of ODataLinkedService.

Properties

AadResourceId

Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).

AadServicePrincipalCredentialType

Specify the credential type (key or cert) is used for service principal.

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

Type of authentication used to connect to the OData service.

AuthHeaders

The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).

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

ConnectVia

The integration runtime reference.

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

LinkedServiceVersion

Version of the linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Parameters

Parameters for linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Password

Password of the OData service.

ServicePrincipalEmbeddedCert

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

ServicePrincipalEmbeddedCertPassword

Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).

ServicePrincipalId

Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

ServicePrincipalKey

Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

Tenant

Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).

Uri

The URL of the OData service endpoint. Type: string (or Expression with resultType string).

UserName

User name of the OData service. 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<ODataLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Converts the provided BinaryData into a model.

IPersistableModel<ODataLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ODataLinkedService>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to