Class DynamicsLinkedService

Dynamics linked service.

Inheritance
System.Object
LinkedService
DynamicsLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.DynamicsLinkedService/DynamicsLinkedServiceConverter))]
public class DynamicsLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

DynamicsLinkedService(Object, Object)

Initializes a new instance of DynamicsLinkedService.

Declaration
public DynamicsLinkedService (object deploymentType, object authenticationType);
Parameters
System.Object deploymentType

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).
System.Object authenticationType

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, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string).
Exceptions
System.ArgumentNullException

deploymentType or authenticationType is null.

Properties

AuthenticationType

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, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string).

Declaration
public object AuthenticationType { get; set; }
Property Value
System.Object

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

DeploymentType

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

Declaration
public object DeploymentType { get; set; }
Property Value
System.Object

Domain

The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string).

Declaration
public object Domain { get; set; }
Property Value
System.Object

EncryptedCredential

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

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

HostName

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

Declaration
public object HostName { get; set; }
Property Value
System.Object

OrganizationName

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

Declaration
public object OrganizationName { get; set; }
Property Value
System.Object

Password

Password to access the Dynamics instance. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password { get; set; }
Property Value
SecretBase

Port

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.

Declaration
public object Port { get; set; }
Property Value
System.Object

ServicePrincipalCredential

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. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalCredential { get; set; }
Property Value
SecretBase

ServicePrincipalCredentialType

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

Declaration
public object ServicePrincipalCredentialType { get; set; }
Property Value
System.Object

ServicePrincipalId

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

Declaration
public object ServicePrincipalId { get; set; }
Property Value
System.Object

ServiceUri

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

Declaration
public object ServiceUri { get; set; }
Property Value
System.Object

Username

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

Declaration
public object Username { get; set; }
Property Value
System.Object