Feedback Edit

ODataLinkedService Class

  • Reference

Open Data Protocol (OData) linked service.

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

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
ODataLinkedService

Constructor

ODataLinkedService(*, url: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, authentication_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ODataAuthenticationType]] = None, user_name: Optional[object] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[object] = None, service_principal_id: Optional[object] = None, aad_resource_id: Optional[object] = None, aad_service_principal_credential_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.ODataAadServicePrincipalCredentialType]] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_embedded_cert: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_embedded_cert_password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[object] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

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

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

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

url
object
Required

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

authentication_type
str or ODataAuthenticationType
Required

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

user_name
object
Required

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

password
SecretBase
Required

Password of the OData service.

tenant
object
Required

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

service_principal_id
object
Required

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

aad_resource_id
object
Required

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
Required

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

service_principal_key
SecretBase
Required

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

service_principal_embedded_cert
SecretBase
Required

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
Required

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
object
Required

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