Share via

ODataLinkedService interface

  • Reference
Package:
@azure/arm-datafactory

Open Data Protocol (OData) linked service.

Extends
LinkedService

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

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
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).
type

Polymorphic discriminator, which specifies the different types this object can be
url

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

Inherited Properties

annotations

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

The integration runtime reference.
description

Linked service description.
parameters

Parameters for linked service.
version

Version of the linked service.

Property Details

aadResourceId

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

aadResourceId?: any

Property Value

any

aadServicePrincipalCredentialType

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

aadServicePrincipalCredentialType?: string

Property Value

string

authenticationType

Type of authentication used to connect to the OData service.

authenticationType?: string

Property Value

string

authHeaders

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

authHeaders?: any

Property Value

any

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

azureCloudType?: any

Property Value

any

encryptedCredential

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

encryptedCredential?: string

Property Value

string

password

Password of the OData service.

password?: SecretBaseUnion

Property Value

SecretBaseUnion

servicePrincipalEmbeddedCert

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

servicePrincipalEmbeddedCert?: SecretBaseUnion

Property Value

SecretBaseUnion

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

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

Property Value

SecretBaseUnion

servicePrincipalId

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

servicePrincipalId?: any

Property Value

any

servicePrincipalKey

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

servicePrincipalKey?: SecretBaseUnion

Property Value

SecretBaseUnion

tenant

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

tenant?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "OData"

Property Value

"OData"

url

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

url: any

Property Value

any

userName

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

userName?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version