Feedback Edit

DynamicsLinkedService Class

  • Reference

Dynamics linked service.

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

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

Constructor

DynamicsLinkedService(*, deployment_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsDeploymentType], authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsAuthenticationType], 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, host_name: Optional[str] = None, port: Optional[str] = None, service_uri: Optional[str] = None, organization_name: Optional[str] = None, username: Optional[object] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, service_principal_id: Optional[object] = None, service_principal_credential_type: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DynamicsServicePrincipalCredentialType]] = None, service_principal_credential: 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.

deployment_type
str or DynamicsDeploymentType
Required

Required. The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string). Possible values include: "Online", "OnPremisesWithIfd".

host_name
str
Required

The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

port
str
Required

The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

service_uri
str
Required

The URL to the Microsoft Dynamics server. The property is required for on- line and not allowed for on-prem. Type: string (or Expression with resultType string).

organization_name
str
Required

The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).

authentication_type
str or DynamicsAuthenticationType
Required

Required. The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string). Possible values include: "Office365", "Ifd", "AADServicePrincipal".

username
object
Required

User name to access the Dynamics instance. Type: string (or Expression with resultType string).

password
SecretBase
Required

Password to access the Dynamics instance.

service_principal_id
object
Required

The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).

service_principal_credential_type
str or DynamicsServicePrincipalCredentialType
Required

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). Possible values include: "ServicePrincipalKey", "ServicePrincipalCert".

service_principal_credential
SecretBase
Required

The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.

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