Class AzureBlobStorageLinkedService


  • public final class AzureBlobStorageLinkedService
    extends LinkedService
    The azure blob storage linked service.
    • Constructor Detail

      • AzureBlobStorageLinkedService

        public AzureBlobStorageLinkedService()
    • Method Detail

      • withAnnotations

        public AzureBlobStorageLinkedService 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.
      • connectionString

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

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

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

        public AzureBlobStorageLinkedService withAccountKey​(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 AzureBlobStorageLinkedService object itself.
      • sasUri

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

        public AzureBlobStorageLinkedService withSasUri​(Object sasUri)
        Set the sasUri property: SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        sasUri - the sasUri value to set.
        Returns:
        the AzureBlobStorageLinkedService object itself.
      • sasToken

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

        public AzureBlobStorageLinkedService withSasToken​(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 AzureBlobStorageLinkedService object itself.
      • serviceEndpoint

        public String serviceEndpoint()
        Get the serviceEndpoint property: Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.
        Returns:
        the serviceEndpoint value.
      • withServiceEndpoint

        public AzureBlobStorageLinkedService withServiceEndpoint​(String serviceEndpoint)
        Set the serviceEndpoint property: Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.
        Parameters:
        serviceEndpoint - the serviceEndpoint value to set.
        Returns:
        the AzureBlobStorageLinkedService object itself.
      • servicePrincipalId

        public Object servicePrincipalId()
        Get the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalId value.
      • withServicePrincipalId

        public AzureBlobStorageLinkedService withServicePrincipalId​(Object servicePrincipalId)
        Set the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalId - the servicePrincipalId value to set.
        Returns:
        the AzureBlobStorageLinkedService object itself.
      • servicePrincipalKey

        public SecretBase servicePrincipalKey()
        Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Data Warehouse.
        Returns:
        the servicePrincipalKey value.
      • withServicePrincipalKey

        public AzureBlobStorageLinkedService withServicePrincipalKey​(SecretBase servicePrincipalKey)
        Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Data Warehouse.
        Parameters:
        servicePrincipalKey - the servicePrincipalKey value to set.
        Returns:
        the AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService object itself.
      • accountKind

        public String accountKind()
        Get the accountKind property: Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).
        Returns:
        the accountKind value.
      • withAccountKind

        public AzureBlobStorageLinkedService withAccountKind​(String accountKind)
        Set the accountKind property: Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).
        Parameters:
        accountKind - the accountKind value to set.
        Returns:
        the AzureBlobStorageLinkedService object itself.
      • encryptedCredential

        public String 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 AzureBlobStorageLinkedService withEncryptedCredential​(String 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 AzureBlobStorageLinkedService object itself.
      • credential

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

        public AzureBlobStorageLinkedService withCredential​(CredentialReference credential)
        Set the credential property: The credential reference containing authentication information.
        Parameters:
        credential - the credential value to set.
        Returns:
        the AzureBlobStorageLinkedService object itself.