Class DynamicsLinkedService
java.lang.Object
com.azure.resourcemanager.datafactory.models.LinkedService
com.azure.resourcemanager.datafactory.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 credential property: The credential reference containing authentication information.Get the deploymentType property: The deployment type of the Dynamics instance.Get the encryptedCredential property: The encrypted credential used for authentication.hostname()
Get the hostname property: The host name of the on-premises Dynamics server.Get the organizationName property: The organization name of the Dynamics instance.password()
Get the password property: Password to access the Dynamics instance.port()
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.username()
Get the username property: User name to access the Dynamics instance.void
validate()
Validates the instance.withAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.withAuthenticationType
(Object authenticationType) Set the authenticationType property: The authentication type to connect to Dynamics server.withConnectVia
(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.withCredential
(CredentialReference credential) Set the credential property: The credential reference containing authentication information.withDeploymentType
(Object deploymentType) Set the deploymentType property: The deployment type of the Dynamics instance.withDescription
(String description) Set the description property: Linked service description.withEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.withHostname
(Object hostname) Set the hostname property: The host name of the on-premises Dynamics server.withOrganizationName
(Object organizationName) Set the organizationName property: The organization name of the Dynamics instance.withParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.withPassword
(SecretBase password) Set the password property: Password to access the Dynamics instance.Set the port property: The port of on-premises Dynamics server.withServicePrincipalCredential
(SecretBase servicePrincipalCredential) Set the servicePrincipalCredential property: The credential of the service principal object in Azure Active Directory.withServicePrincipalCredentialType
(Object servicePrincipalCredentialType) Set the servicePrincipalCredentialType property: The service principal credential type to use in Server-To-Server authentication.withServicePrincipalId
(Object servicePrincipalId) Set the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Server-To-Server authentication.withServiceUri
(Object serviceUri) Set the serviceUri property: The URL to the Microsoft Dynamics server.withUsername
(Object username) Set the username property: User name to access the Dynamics instance.Methods inherited from class com.azure.resourcemanager.datafactory.models.LinkedService
additionalProperties, annotations, connectVia, description, parameters, withAdditionalProperties
-
Constructor Details
-
DynamicsLinkedService
public DynamicsLinkedService()Creates an instance of DynamicsLinkedService class.
-
-
Method Details
-
withConnectVia
Set the connectVia property: The integration runtime reference.- Overrides:
withConnectVia
in classLinkedService
- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the LinkedService object itself.
-
withDescription
Set the description property: Linked service description.- Overrides:
withDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
withParameters
Set the parameters property: Parameters for linked service.- Overrides:
withParameters
in classLinkedService
- Parameters:
parameters
- the parameters value to set.- Returns:
- the LinkedService object itself.
-
withAnnotations
Set the annotations property: List of tags that can be used for describing the linked service.- Overrides:
withAnnotations
in classLinkedService
- Parameters:
annotations
- the annotations value to set.- Returns:
- the LinkedService object itself.
-
deploymentType
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.
-
withDeploymentType
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.
-
hostname
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.
-
withHostname
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.
-
port
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.
-
withPort
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.
-
serviceUri
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.
-
withServiceUri
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.
-
organizationName
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.
-
withOrganizationName
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.
-
authenticationType
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.
-
withAuthenticationType
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.
-
username
Get the username property: User name to access the Dynamics instance. Type: string (or Expression with resultType string).- Returns:
- the username value.
-
withUsername
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.
-
password
Get the password property: Password to access the Dynamics instance.- Returns:
- the password value.
-
withPassword
Set the password property: Password to access the Dynamics instance.- Parameters:
password
- the password value to set.- Returns:
- the DynamicsLinkedService object itself.
-
servicePrincipalId
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.
-
withServicePrincipalId
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.
-
servicePrincipalCredentialType
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.
-
withServicePrincipalCredentialType
public DynamicsLinkedService withServicePrincipalCredentialType(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.
-
servicePrincipalCredential
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.
-
withServicePrincipalCredential
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.
-
encryptedCredential
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.
-
withEncryptedCredential
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.
-
credential
Get the credential property: The credential reference containing authentication information.- Returns:
- the credential value.
-
withCredential
Set the credential property: The credential reference containing authentication information.- Parameters:
credential
- the credential value to set.- Returns:
- the DynamicsLinkedService object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classLinkedService
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-