Share via

SalesforceLinkedService Class

Linked service for Salesforce.

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

Constructor

SalesforceLinkedService(*, 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, environment_url: MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, security_token: _models.SecretBase | None = None, api_version: MutableMapping[str, Any] | 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.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via
IntegrationRuntimeReference

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters
dict[str, ParameterSpecification]

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
environment_url
<xref:JSON>

The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

Default value: None
username
<xref:JSON>

The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

Default value: None
password
SecretBase

The password for Basic authentication of the Salesforce instance.

Default value: None
security_token
SecretBase

The security token is optional to remotely access Salesforce instance.

Default value: None
api_version
<xref:JSON>

The Salesforce API version used in ADF. Type: string (or Expression with resultType string).

Default value: None
encrypted_credential
str

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
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.
environment_url
<xref:JSON>

The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).
username
<xref:JSON>

The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).
password
SecretBase

The password for Basic authentication of the Salesforce instance.
security_token
SecretBase

The security token is optional to remotely access Salesforce instance.
api_version
<xref:JSON>

The Salesforce API version used in ADF. 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.