Class DynamicsLinkedService
java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.DynamicsLinkedService
Dynamics linked service.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the authenticationType property: The authentication type to connect to Dynamics server.Get the deploymentType property: The deployment type of the Dynamics instance.Get the encryptedCredential property: The encrypted credential used for authentication.Get the hostName property: The host name of the on-premises Dynamics server.Get the organizationName property: The organization name of the Dynamics instance.Get the password property: Password to access the Dynamics instance.getPort()
Get the port property: The port of on-premises Dynamics server.Get the servicePrincipalCredential property: The credential of the service principal object in Azure Active Directory.Get the servicePrincipalCredentialType property: The service principal credential type to use in Server-To-Server authentication.Get the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Server-To-Server authentication.Get the serviceUri property: The URL to the Microsoft Dynamics server.Get the username property: User name to access the Dynamics instance.setAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.setAuthenticationType
(Object authenticationType) Set the authenticationType property: The authentication type to connect to Dynamics server.setConnectVia
(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.setDeploymentType
(Object deploymentType) Set the deploymentType property: The deployment type of the Dynamics instance.setDescription
(String description) Set the description property: Linked service description.setEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.setHostName
(Object hostName) Set the hostName property: The host name of the on-premises Dynamics server.setOrganizationName
(Object organizationName) Set the organizationName property: The organization name of the Dynamics instance.setParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.setPassword
(SecretBase password) Set the password property: Password to access the Dynamics instance.Set the port property: The port of on-premises Dynamics server.setServicePrincipalCredential
(SecretBase servicePrincipalCredential) Set the servicePrincipalCredential property: The credential of the service principal object in Azure Active Directory.setServicePrincipalCredentialType
(Object servicePrincipalCredentialType) Set the servicePrincipalCredentialType property: The service principal credential type to use in Server-To-Server authentication.setServicePrincipalId
(Object servicePrincipalId) Set the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Server-To-Server authentication.setServiceUri
(Object serviceUri) Set the serviceUri property: The URL to the Microsoft Dynamics server.setUsername
(Object username) Set the username property: User name to access the Dynamics instance.Methods inherited from class com.azure.analytics.synapse.artifacts.models.LinkedService
getAdditionalProperties, getAnnotations, getConnectVia, getDescription, getParameters, setAdditionalProperties
-
Constructor Details
-
DynamicsLinkedService
public DynamicsLinkedService()
-
-
Method Details
-
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
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
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
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
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
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
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
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
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
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
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
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
Get the username property: User name to access the Dynamics instance. Type: string (or Expression with resultType string).- Returns:
- the username value.
-
setUsername
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
Get the password property: Password to access the Dynamics instance.- Returns:
- the password value.
-
setPassword
Set the password property: Password to access the Dynamics instance.- Parameters:
password
- the password value to set.- Returns:
- the DynamicsLinkedService object itself.
-
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
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
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
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
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
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
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.
-
setConnectVia
Set the connectVia property: The integration runtime reference.- Overrides:
setConnectVia
in classLinkedService
- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the LinkedService object itself.
-
setDescription
Set the description property: Linked service description.- Overrides:
setDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
setParameters
Set the parameters property: Parameters for linked service.- Overrides:
setParameters
in classLinkedService
- Parameters:
parameters
- the parameters value to set.- Returns:
- the LinkedService object itself.
-
setAnnotations
Set the annotations property: List of tags that can be used for describing the linked service.- Overrides:
setAnnotations
in classLinkedService
- Parameters:
annotations
- the annotations value to set.- Returns:
- the LinkedService object itself.
-