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

Class DynamicsCrmLinkedService

  • public class DynamicsCrmLinkedService
extends LinkedService
    Dynamics CRM linked service.

    • Constructor Detail

      • DynamicsCrmLinkedService

        public DynamicsCrmLinkedService()

    • Method Detail

      • getDeploymentType

        public Object getDeploymentType()
        Get the deploymentType property: The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).
        Returns:
        the deploymentType value.

      • setDeploymentType

        public DynamicsCrmLinkedService setDeploymentType​(Object deploymentType)
        Set the deploymentType property: The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).
        Parameters:
        deploymentType - the deploymentType value to set.
        Returns:
        the DynamicsCrmLinkedService object itself.

      • getHostName

        public Object getHostName()
        Get the hostName property: The host name of the on-premises Dynamics CRM 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 DynamicsCrmLinkedService setHostName​(Object hostName)
        Set the hostName property: The host name of the on-premises Dynamics CRM 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 DynamicsCrmLinkedService object itself.

      • getPort

        public Object getPort()
        Get the port property: The port of on-premises Dynamics CRM 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 DynamicsCrmLinkedService setPort​(Object port)
        Set the port property: The port of on-premises Dynamics CRM 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 DynamicsCrmLinkedService object itself.

      • getServiceUri

        public Object getServiceUri()
        Get the serviceUri property: The URL to the Microsoft Dynamics CRM 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 DynamicsCrmLinkedService setServiceUri​(Object serviceUri)
        Set the serviceUri property: The URL to the Microsoft Dynamics CRM 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 DynamicsCrmLinkedService object itself.

      • getOrganizationName

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

      • setOrganizationName

        public DynamicsCrmLinkedService setOrganizationName​(Object organizationName)
        Set the organizationName property: The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).
        Parameters:
        organizationName - the organizationName value to set.
        Returns:
        the DynamicsCrmLinkedService object itself.

      • getAuthenticationType

        public Object getAuthenticationType()
        Get the authenticationType property: The authentication type to connect to Dynamics CRM 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 DynamicsCrmLinkedService setAuthenticationType​(Object authenticationType)
        Set the authenticationType property: The authentication type to connect to Dynamics CRM 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 DynamicsCrmLinkedService object itself.

      • getUsername

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

      • setUsername

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

      • getPassword

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

      • setPassword

        public DynamicsCrmLinkedService setPassword​(SecretBase password)
        Set the password property: Password to access the Dynamics CRM instance.
        Parameters:
        password - the password value to set.
        Returns:
        the DynamicsCrmLinkedService 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 DynamicsCrmLinkedService 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 DynamicsCrmLinkedService object itself.

      • getServicePrincipalCredentialType

        public Object getServicePrincipalCredentialType()
        Get the servicePrincipalCredentialType property: A string from ServicePrincipalCredentialEnum or an expression.
        Returns:
        the servicePrincipalCredentialType value.

      • setServicePrincipalCredentialType

        public DynamicsCrmLinkedService setServicePrincipalCredentialType​(Object servicePrincipalCredentialType)
        Set the servicePrincipalCredentialType property: A string from ServicePrincipalCredentialEnum or an expression.
        Parameters:
        servicePrincipalCredentialType - the servicePrincipalCredentialType value to set.
        Returns:
        the DynamicsCrmLinkedService 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 DynamicsCrmLinkedService 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 DynamicsCrmLinkedService 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 DynamicsCrmLinkedService 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 DynamicsCrmLinkedService object itself.

      • setDescription

        public DynamicsCrmLinkedService 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 DynamicsCrmLinkedService 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.