ODataLinkedService Class
Open Data Protocol (OData) linked service.
All required parameters must be populated in order to send to server.
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
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
version
|
Version of the linked service. Default value: None
|
|
connect_via
|
The integration runtime reference. Default value: None
|
|
description
|
Linked service description. Default value: None
|
|
parameters
|
Parameters for linked service. Default value: None
|
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. Default value: None
|
|
url
|
<xref:JSON>
The URL of the OData service endpoint. Type: string (or Expression with resultType string). Required. |
|
authentication_type
|
Type of authentication used to connect to the OData service. Known values are: "Basic", "Anonymous", "Windows", "AadServicePrincipal", and "ManagedServiceIdentity". Default value: None
|
|
user_name
|
<xref:JSON>
User name of the OData service. Type: string (or Expression with resultType string). Default value: None
|
|
password
|
Password of the OData service. Default value: None
|
|
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). Default value: None
|
|
tenant
|
<xref:JSON>
Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string). Default value: None
|
|
service_principal_id
|
<xref:JSON>
Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). Default value: None
|
|
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). Default value: None
|
|
aad_resource_id
|
<xref:JSON>
Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string). Default value: None
|
|
aad_service_principal_credential_type
|
Specify the credential type (key or cert) is used for service principal. Known values are: "ServicePrincipalKey" and "ServicePrincipalCert". Default value: None
|
|
service_principal_key
|
Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). Default value: None
|
|
service_principal_embedded_cert
|
Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). Default value: None
|
|
service_principal_embedded_cert_password
|
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). Default value: None
|
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of linked service. Required. |
|
version
|
Version of the linked service. |
|
connect_via
|
The integration runtime reference. |
|
description
|
Linked service description. |
|
parameters
|
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
|
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
|
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
|
Specify the credential type (key or cert) is used for service principal. Known values are: "ServicePrincipalKey" and "ServicePrincipalCert". |
|
service_principal_key
|
Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). |
|
service_principal_embedded_cert
|
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
|
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
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
