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

Class CosmosDbLinkedService

  • public class CosmosDbLinkedService
extends LinkedService
    Microsoft Azure Cosmos Database (CosmosDB) linked service.

    • Constructor Detail

      • CosmosDbLinkedService

        public CosmosDbLinkedService()

    • Method Detail

      • getConnectionString

        public Object getConnectionString()
        Get the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
        Returns:
        the connectionString value.

      • setConnectionString

        public CosmosDbLinkedService setConnectionString​(Object connectionString)
        Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        connectionString - the connectionString value to set.
        Returns:
        the CosmosDbLinkedService object itself.

      • getAccountEndpoint

        public Object getAccountEndpoint()
        Get the accountEndpoint property: The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).
        Returns:
        the accountEndpoint value.

      • setAccountEndpoint

        public CosmosDbLinkedService setAccountEndpoint​(Object accountEndpoint)
        Set the accountEndpoint property: The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).
        Parameters:
        accountEndpoint - the accountEndpoint value to set.
        Returns:
        the CosmosDbLinkedService object itself.

      • getDatabase

        public Object getDatabase()
        Get the database property: The name of the database. Type: string (or Expression with resultType string).
        Returns:
        the database value.

      • setDatabase

        public CosmosDbLinkedService setDatabase​(Object database)
        Set the database property: The name of the database. Type: string (or Expression with resultType string).
        Parameters:
        database - the database value to set.
        Returns:
        the CosmosDbLinkedService object itself.

      • getAccountKey

        public SecretBase getAccountKey()
        Get the accountKey property: The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.
        Returns:
        the accountKey value.

      • setAccountKey

        public CosmosDbLinkedService setAccountKey​(SecretBase accountKey)
        Set the accountKey property: The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.
        Parameters:
        accountKey - the accountKey value to set.
        Returns:
        the CosmosDbLinkedService 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 CosmosDbLinkedService 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 CosmosDbLinkedService object itself.

      • setDescription

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