Class AzureBlobFSLinkedService


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

      • AzureBlobFSLinkedService

        public AzureBlobFSLinkedService()
    • Method Detail

      • withDescription

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

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

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

        public AzureBlobFSLinkedService withUrl​(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.
      • accountKey

        public Object accountKey()
        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.
      • withAccountKey

        public AzureBlobFSLinkedService withAccountKey​(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.
      • servicePrincipalId

        public Object servicePrincipalId()
        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.
      • withServicePrincipalId

        public AzureBlobFSLinkedService withServicePrincipalId​(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.
      • servicePrincipalKey

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

        public AzureBlobFSLinkedService withServicePrincipalKey​(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.
      • tenant

        public Object tenant()
        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.
      • withTenant

        public AzureBlobFSLinkedService withTenant​(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.
      • azureCloudType

        public Object azureCloudType()
        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.
      • withAzureCloudType

        public AzureBlobFSLinkedService withAzureCloudType​(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.
      • 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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService object itself.
      • credential

        public CredentialReference credential()
        Get the credential property: The credential reference containing authentication information.
        Returns:
        the credential value.
      • withCredential

        public AzureBlobFSLinkedService withCredential​(CredentialReference credential)
        Set the credential property: The credential reference containing authentication information.
        Parameters:
        credential - the credential value to set.
        Returns:
        the AzureBlobFSLinkedService 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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService 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 AzureBlobFSLinkedService object itself.