ODataLinkedService Class

Reference

Open Data Protocol (OData) linked service.

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

Inheritance: azure.mgmt.datafactory.models._models_py3.LinkedService

ODataLinkedService

Constructor

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

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
url	<xref:JSON> The URL of the OData service endpoint. Type: string (or Expression with resultType string). Required.
authentication_type	str or ODataAuthenticationType Type of authentication used to connect to the OData service. Known values are: "Basic", "Anonymous", "Windows", "AadServicePrincipal", and "ManagedServiceIdentity".
user_name	<xref:JSON> User name of the OData service. Type: string (or Expression with resultType string).
password	SecretBase Password of the OData service.
auth_headers	<xref:JSON> The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
tenant	<xref:JSON> Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
service_principal_id	<xref:JSON> Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
azure_cloud_type	<xref:JSON> 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	<xref:JSON> 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" and "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	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Type of linked service. Required.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
url	<xref:JSON> The URL of the OData service endpoint. Type: string (or Expression with resultType string). Required.
authentication_type	str or ODataAuthenticationType Type of authentication used to connect to the OData service. Known values are: "Basic", "Anonymous", "Windows", "AadServicePrincipal", and "ManagedServiceIdentity".
user_name	<xref:JSON> User name of the OData service. Type: string (or Expression with resultType string).
password	SecretBase Password of the OData service.
auth_headers	<xref:JSON> The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type).
tenant	<xref:JSON> Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).
service_principal_id	<xref:JSON> Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
azure_cloud_type	<xref:JSON> 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	<xref:JSON> 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" and "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	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Share via

ODataLinkedService Class

Constructor

Keyword-Only Parameters

Variables

Additional resources