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

Class AzureBlobFSLinkedService

  • public class AzureBlobFSLinkedService
extends LinkedService
    Azure Data Lake Storage Gen2 linked service.

    • Constructor Detail

      • AzureBlobFSLinkedService

        public AzureBlobFSLinkedService()

    • Method Detail

      • getUrl

        public Object getUrl()
        Get the url property: Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).
        Returns:
        the url value.

      • setUrl

        public AzureBlobFSLinkedService setUrl​(Object url)
        Set the url property: Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).
        Parameters:
        url - the url value to set.
        Returns:
        the AzureBlobFSLinkedService object itself.

      • getAccountKey

        public Object getAccountKey()
        Get the accountKey property: Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).
        Returns:
        the accountKey value.

      • setAccountKey

        public AzureBlobFSLinkedService setAccountKey​(Object accountKey)
        Set the accountKey property: Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).
        Parameters:
        accountKey - the accountKey value to set.
        Returns:
        the AzureBlobFSLinkedService object itself.

      • getServicePrincipalId

        public Object getServicePrincipalId()
        Get the servicePrincipalId property: The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalId value.

      • setServicePrincipalId

        public AzureBlobFSLinkedService setServicePrincipalId​(Object servicePrincipalId)
        Set the servicePrincipalId property: The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalId - the servicePrincipalId value to set.
        Returns:
        the AzureBlobFSLinkedService object itself.

      • getServicePrincipalKey

        public SecretBase getServicePrincipalKey()
        Get the servicePrincipalKey property: The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.
        Returns:
        the servicePrincipalKey value.

      • setServicePrincipalKey

        public AzureBlobFSLinkedService setServicePrincipalKey​(SecretBase servicePrincipalKey)
        Set the servicePrincipalKey property: The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.
        Parameters:
        servicePrincipalKey - the servicePrincipalKey value to set.
        Returns:
        the AzureBlobFSLinkedService object itself.

      • getTenant

        public Object getTenant()
        Get the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
        Returns:
        the tenant value.

      • setTenant

        public AzureBlobFSLinkedService setTenant​(Object tenant)
        Set the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
        Parameters:
        tenant - the tenant value to set.
        Returns:
        the AzureBlobFSLinkedService object itself.

      • getAzureCloudType

        public Object getAzureCloudType()
        Get the azureCloudType property: Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
        Returns:
        the azureCloudType value.

      • setAzureCloudType

        public AzureBlobFSLinkedService setAzureCloudType​(Object azureCloudType)
        Set the azureCloudType property: Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
        Parameters:
        azureCloudType - the azureCloudType value to set.
        Returns:
        the AzureBlobFSLinkedService object itself.

      • getServicePrincipalCredentialType

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

      • setServicePrincipalCredentialType

        public AzureBlobFSLinkedService setServicePrincipalCredentialType​(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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService object itself.

      • setDescription

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