Class ODataLinkedService

Open Data Protocol (OData) linked service.

Inheritance
System.Object
LinkedService
ODataLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.ODataLinkedService/ODataLinkedServiceConverter))]
public class ODataLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

ODataLinkedService(Object)

Initializes a new instance of ODataLinkedService.

Declaration
public ODataLinkedService (object url);
Parameters
System.Object url

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

url is null.

Properties

AadResourceId

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

Declaration
public object AadResourceId { get; set; }
Property Value
System.Object

AadServicePrincipalCredentialType

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

Declaration
public Nullable<Azure.Analytics.Synapse.Artifacts.Models.ODataAadServicePrincipalCredentialType> AadServicePrincipalCredentialType { get; set; }
Property Value
System.Nullable<ODataAadServicePrincipalCredentialType>

AuthenticationType

Type of authentication used to connect to the OData service.

Declaration
public Nullable<Azure.Analytics.Synapse.Artifacts.Models.ODataAuthenticationType> AuthenticationType { get; set; }
Property Value
System.Nullable<ODataAuthenticationType>

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

Declaration
public object AzureCloudType { get; set; }
Property Value
System.Object

EncryptedCredential

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

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

Password

Password of the OData service. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password { get; set; }
Property Value
SecretBase

ServicePrincipalEmbeddedCert

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalEmbeddedCert { get; set; }
Property Value
SecretBase

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). Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalEmbeddedCertPassword { get; set; }
Property Value
SecretBase

ServicePrincipalId

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

Declaration
public object ServicePrincipalId { get; set; }
Property Value
System.Object

ServicePrincipalKey

Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalKey { get; set; }
Property Value
SecretBase

Tenant

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

Declaration
public object Tenant { get; set; }
Property Value
System.Object

Url

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

Declaration
public object Url { get; set; }
Property Value
System.Object

UserName

User name of the OData service. Type: string (or Expression with resultType string).

Declaration
public object UserName { get; set; }
Property Value
System.Object