ODataLinkedService Class

Open Data Protocol (OData) linked service.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.datafactory.models._models_py3.LinkedService

ODataLinkedService

Constructor

ODataLinkedService(*, url: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[_models.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, _models.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, authentication_type: Optional[Union[str, _models.ODataAuthenticationType]] = None, user_name: Optional[Any] = None, password: Optional[_models.SecretBase] = None, auth_headers: Optional[Any] = None, tenant: Optional[Any] = None, service_principal_id: Optional[Any] = None, azure_cloud_type: Optional[Any] = None, aad_resource_id: Optional[Any] = None, aad_service_principal_credential_type: Optional[Union[str, _models.ODataAadServicePrincipalCredentialType]] = None, service_principal_key: Optional[_models.SecretBase] = None, service_principal_embedded_cert: Optional[_models.SecretBase] = None, service_principal_embedded_cert_password: Optional[_models.SecretBase] = None, encrypted_credential: Optional[Any] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Type of linked service.Constant filled by server.

connect_via

IntegrationRuntimeReference

The integration runtime reference.

description

str

Linked service description.

parameters

dict[str, ParameterSpecification]

Parameters for linked service.

annotations

list[any]

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

url

any

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

authentication_type

str or ODataAuthenticationType

Type of authentication used to connect to the OData service. Known values are: "Basic", "Anonymous", "Windows", "AadServicePrincipal", "ManagedServiceIdentity".

user_name

any

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

password

SecretBase

Password of the OData service.

auth_headers

any

The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).

tenant

any

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

service_principal_id

any

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

azure_cloud_type

any

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

aad_resource_id

any

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

aad_service_principal_credential_type

str or ODataAadServicePrincipalCredentialType

Specify the credential type (key or cert) is used for service principal. Known values are: "ServicePrincipalKey", "ServicePrincipalCert".

service_principal_key

SecretBase

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

service_principal_embedded_cert

SecretBase

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

service_principal_embedded_cert_password

SecretBase

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

encrypted_credential

any

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