Package com.azure.resourcemanager.datafactory.models

Class CommonDataServiceForAppsLinkedService

java.lang.Object
com.azure.resourcemanager.datafactory.models.LinkedService
com.azure.resourcemanager.datafactory.models.CommonDataServiceForAppsLinkedService
public final class CommonDataServiceForAppsLinkedService extends LinkedService
Common Data Service for Apps linked service.

  • Constructor Details

    • CommonDataServiceForAppsLinkedService

      public CommonDataServiceForAppsLinkedService()
      Creates an instance of CommonDataServiceForAppsLinkedService class.

  • Method Details

    • withConnectVia

      public CommonDataServiceForAppsLinkedService withConnectVia(IntegrationRuntimeReference connectVia)
      Set the connectVia property: The integration runtime reference.
      Overrides:
      withConnectVia in class LinkedService
      Parameters:
      connectVia - the connectVia value to set.
      Returns:
      the LinkedService object itself.

    • withDescription

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

    • withParameters

      public CommonDataServiceForAppsLinkedService withParameters(Map<String,ParameterSpecification> parameters)
      Set the parameters property: Parameters for linked service.
      Overrides:
      withParameters in class LinkedService
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the LinkedService object itself.

    • withAnnotations

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

    • deploymentType

      public Object deploymentType()
      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.

    • withDeploymentType

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

    • hostname

      public Object hostname()
      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.

    • withHostname

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

    • port

      public Object port()
      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.

    • withPort

      public CommonDataServiceForAppsLinkedService withPort(Object port)
      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.

    • serviceUri

      public Object serviceUri()
      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.

    • withServiceUri

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

    • organizationName

      public Object organizationName()
      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.

    • withOrganizationName

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

    • authenticationType

      public Object authenticationType()
      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.

    • withAuthenticationType

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

    • username

      public Object username()
      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.

    • withUsername

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

    • password

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

    • withPassword

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

    • servicePrincipalId

      public Object 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

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

    • servicePrincipalCredentialType

      public Object 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 CommonDataServiceForAppsLinkedService 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 CommonDataServiceForAppsLinkedService object itself.

    • servicePrincipalCredential

      public SecretBase 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

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

    • encryptedCredential

      public Object 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

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

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class LinkedService
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.