Package com.azure.analytics.synapse.artifacts.models

Class DynamicsLinkedService

  • public class DynamicsLinkedService
extends LinkedService
    Dynamics linked service.

    • Constructor Detail

      • DynamicsLinkedService

        public DynamicsLinkedService()

    • Method Detail

      • getDeploymentType

        public Object getDeploymentType()
        Get the deploymentType property: 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).
        Returns:
        the deploymentType value.

      • setDeploymentType

        public DynamicsLinkedService setDeploymentType​(Object deploymentType)
        Set the deploymentType property: 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).
        Parameters:
        deploymentType - the deploymentType value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getHostName

        public Object getHostName()
        Get the hostName property: 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).
        Returns:
        the hostName value.

      • setHostName

        public DynamicsLinkedService setHostName​(Object hostName)
        Set the hostName property: 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).
        Parameters:
        hostName - the hostName value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getPort

        public Object getPort()
        Get the port property: 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.
        Returns:
        the port value.

      • setPort

        public DynamicsLinkedService setPort​(Object port)
        Set the port property: 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.
        Parameters:
        port - the port value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getServiceUri

        public Object getServiceUri()
        Get the serviceUri property: 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).
        Returns:
        the serviceUri value.

      • setServiceUri

        public DynamicsLinkedService setServiceUri​(Object serviceUri)
        Set the serviceUri property: 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).
        Parameters:
        serviceUri - the serviceUri value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getOrganizationName

        public Object getOrganizationName()
        Get the organizationName property: 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).
        Returns:
        the organizationName value.

      • setOrganizationName

        public DynamicsLinkedService setOrganizationName​(Object organizationName)
        Set the organizationName property: 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).
        Parameters:
        organizationName - the organizationName value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getAuthenticationType

        public Object getAuthenticationType()
        Get the authenticationType property: 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).
        Returns:
        the authenticationType value.

      • setAuthenticationType

        public DynamicsLinkedService setAuthenticationType​(Object authenticationType)
        Set the authenticationType property: 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).
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getUsername

        public Object getUsername()
        Get the username property: User name to access the Dynamics instance. Type: string (or Expression with resultType string).
        Returns:
        the username value.

      • setUsername

        public DynamicsLinkedService setUsername​(Object username)
        Set the username property: User name to access the Dynamics instance. Type: string (or Expression with resultType string).
        Parameters:
        username - the username value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getPassword

        public SecretBase getPassword()
        Get the password property: Password to access the Dynamics instance.
        Returns:
        the password value.

      • setPassword

        public DynamicsLinkedService setPassword​(SecretBase password)
        Set the password property: Password to access the Dynamics instance.
        Parameters:
        password - the password value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getServicePrincipalId

        public Object getServicePrincipalId()
        Get the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalId value.

      • setServicePrincipalId

        public DynamicsLinkedService setServicePrincipalId​(Object servicePrincipalId)
        Set the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalId - the servicePrincipalId value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getServicePrincipalCredentialType

        public Object getServicePrincipalCredentialType()
        Get the servicePrincipalCredentialType property: 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).
        Returns:
        the servicePrincipalCredentialType value.

      • setServicePrincipalCredentialType

        public DynamicsLinkedService setServicePrincipalCredentialType​(Object servicePrincipalCredentialType)
        Set the servicePrincipalCredentialType property: 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).
        Parameters:
        servicePrincipalCredentialType - the servicePrincipalCredentialType value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getServicePrincipalCredential

        public SecretBase getServicePrincipalCredential()
        Get the servicePrincipalCredential property: 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.
        Returns:
        the servicePrincipalCredential value.

      • setServicePrincipalCredential

        public DynamicsLinkedService setServicePrincipalCredential​(SecretBase servicePrincipalCredential)
        Set the servicePrincipalCredential property: 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.
        Parameters:
        servicePrincipalCredential - the servicePrincipalCredential value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • getEncryptedCredential

        public Object getEncryptedCredential()
        Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.

      • setEncryptedCredential

        public DynamicsLinkedService setEncryptedCredential​(Object encryptedCredential)
        Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Parameters:
        encryptedCredential - the encryptedCredential value to set.
        Returns:
        the DynamicsLinkedService object itself.

      • setDescription

        public DynamicsLinkedService setDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        setDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.

      • setAnnotations

        public DynamicsLinkedService setAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        setAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.