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

Class AzureFileStorageLinkedService

  • public class AzureFileStorageLinkedService
extends LinkedService
    Azure File Storage linked service.

    • Constructor Detail

      • AzureFileStorageLinkedService

        public AzureFileStorageLinkedService()

    • Method Detail

      • getHost

        public Object getHost()
        Get the host property: Host name of the server. Type: string (or Expression with resultType string).
        Returns:
        the host value.

      • setHost

        public AzureFileStorageLinkedService setHost​(Object host)
        Set the host property: Host name of the server. Type: string (or Expression with resultType string).
        Parameters:
        host - the host value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getUserId

        public Object getUserId()
        Get the userId property: User ID to logon the server. Type: string (or Expression with resultType string).
        Returns:
        the userId value.

      • setUserId

        public AzureFileStorageLinkedService setUserId​(Object userId)
        Set the userId property: User ID to logon the server. Type: string (or Expression with resultType string).
        Parameters:
        userId - the userId value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getPassword

        public SecretBase getPassword()
        Get the password property: Password to logon the server.
        Returns:
        the password value.

      • setPassword

        public AzureFileStorageLinkedService setPassword​(SecretBase password)
        Set the password property: Password to logon the server.
        Parameters:
        password - the password value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getConnectionString

        public Object getConnectionString()
        Get the connectionString property: The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
        Returns:
        the connectionString value.

      • setConnectionString

        public AzureFileStorageLinkedService setConnectionString​(Object connectionString)
        Set the connectionString property: The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        connectionString - the connectionString value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getAccountKey

        public AzureKeyVaultSecretReference getAccountKey()
        Get the accountKey property: The Azure key vault secret reference of accountKey in connection string.
        Returns:
        the accountKey value.

      • setAccountKey

        public AzureFileStorageLinkedService setAccountKey​(AzureKeyVaultSecretReference accountKey)
        Set the accountKey property: The Azure key vault secret reference of accountKey in connection string.
        Parameters:
        accountKey - the accountKey value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getSasUri

        public Object getSasUri()
        Get the sasUri property: SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
        Returns:
        the sasUri value.

      • setSasUri

        public AzureFileStorageLinkedService setSasUri​(Object sasUri)
        Set the sasUri property: SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        sasUri - the sasUri value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getSasToken

        public AzureKeyVaultSecretReference getSasToken()
        Get the sasToken property: The Azure key vault secret reference of sasToken in sas uri.
        Returns:
        the sasToken value.

      • setSasToken

        public AzureFileStorageLinkedService setSasToken​(AzureKeyVaultSecretReference sasToken)
        Set the sasToken property: The Azure key vault secret reference of sasToken in sas uri.
        Parameters:
        sasToken - the sasToken value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getFileShare

        public Object getFileShare()
        Get the fileShare property: The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).
        Returns:
        the fileShare value.

      • setFileShare

        public AzureFileStorageLinkedService setFileShare​(Object fileShare)
        Set the fileShare property: The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).
        Parameters:
        fileShare - the fileShare value to set.
        Returns:
        the AzureFileStorageLinkedService object itself.

      • getSnapshot

        public Object getSnapshot()
        Get the snapshot property: The azure file share snapshot version. Type: string (or Expression with resultType string).
        Returns:
        the snapshot value.

      • setSnapshot

        public AzureFileStorageLinkedService setSnapshot​(Object snapshot)
        Set the snapshot property: The azure file share snapshot version. Type: string (or Expression with resultType string).
        Parameters:
        snapshot - the snapshot value to set.
        Returns:
        the AzureFileStorageLinkedService 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 AzureFileStorageLinkedService 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 AzureFileStorageLinkedService object itself.

      • setAnnotations

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