Class CommonDataServiceForAppsLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.CommonDataServiceForAppsLinkedService

public class CommonDataServiceForAppsLinkedService extends LinkedService
Common Data Service for Apps linked service.
  • Constructor Details

    • CommonDataServiceForAppsLinkedService

      public CommonDataServiceForAppsLinkedService()
  • Method Details

    • getDeploymentType

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

      public CommonDataServiceForAppsLinkedService setDeploymentType(Object deploymentType)
      Set the deploymentType property: The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string).
      Parameters:
      deploymentType - the deploymentType value to set.
      Returns:
      the CommonDataServiceForAppsLinkedService object itself.
    • getHostName

      public Object getHostName()
      Get the hostName property: The host name of the on-premises Common Data Service for Apps 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 CommonDataServiceForAppsLinkedService setHostName(Object hostName)
      Set the hostName property: The host name of the on-premises Common Data Service for Apps 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 CommonDataServiceForAppsLinkedService object itself.
    • getPort

      public Object getPort()
      Get the port property: The port of on-premises Common Data Service for Apps 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 Common Data Service for Apps 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 CommonDataServiceForAppsLinkedService object itself.
    • getServiceUri

      public Object getServiceUri()
      Get the serviceUri property: The URL to the Microsoft Common Data Service for Apps 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 CommonDataServiceForAppsLinkedService setServiceUri(Object serviceUri)
      Set the serviceUri property: The URL to the Microsoft Common Data Service for Apps 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 CommonDataServiceForAppsLinkedService object itself.
    • getOrganizationName

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

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

      public Object getAuthenticationType()
      Get the authenticationType property: The authentication type to connect to Common Data Service for Apps 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 CommonDataServiceForAppsLinkedService setAuthenticationType(Object authenticationType)
      Set the authenticationType property: The authentication type to connect to Common Data Service for Apps 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 CommonDataServiceForAppsLinkedService object itself.
    • getUsername

      public Object getUsername()
      Get the username property: User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).
      Returns:
      the username value.
    • setUsername

      public CommonDataServiceForAppsLinkedService setUsername(Object username)
      Set the username property: User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).
      Parameters:
      username - the username value to set.
      Returns:
      the CommonDataServiceForAppsLinkedService object itself.
    • getPassword

      public SecretBase getPassword()
      Get the password property: Password to access the Common Data Service for Apps instance.
      Returns:
      the password value.
    • setPassword

      public CommonDataServiceForAppsLinkedService setPassword(SecretBase password)
      Set the password property: Password to access the Common Data Service for Apps instance.
      Parameters:
      password - the password value to set.
      Returns:
      the CommonDataServiceForAppsLinkedService 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 CommonDataServiceForAppsLinkedService 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 CommonDataServiceForAppsLinkedService object itself.
    • getServicePrincipalCredentialType

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

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

      Set the connectVia property: The integration runtime reference.
      Overrides:
      setConnectVia in class LinkedService
      Parameters:
      connectVia - the connectVia value to set.
      Returns:
      the LinkedService object itself.
    • setDescription

      public CommonDataServiceForAppsLinkedService 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.
    • setParameters

      Set the parameters property: Parameters for linked service.
      Overrides:
      setParameters in class LinkedService
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the LinkedService object itself.
    • setAnnotations

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