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

Class AzureBlobStorageLinkedService

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

    • Constructor Detail

      • AzureBlobStorageLinkedService

        public AzureBlobStorageLinkedService()

    • Method Detail

      • getConnectionString

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

      • setConnectionString

        public AzureBlobStorageLinkedService setConnectionString​(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.

      • 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService object itself.

      • getSasUri

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

      • setSasUri

        public AzureBlobStorageLinkedService setSasUri​(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.

      • 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService object itself.

      • getServiceEndpoint

        public String getServiceEndpoint()
        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.

      • setServiceEndpoint

        public AzureBlobStorageLinkedService setServiceEndpoint​(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.

      • getServicePrincipalId

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

      • setServicePrincipalId

        public AzureBlobStorageLinkedService setServicePrincipalId​(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.

      • getServicePrincipalKey

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

      • setServicePrincipalKey

        public AzureBlobStorageLinkedService setServicePrincipalKey​(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.

      • 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService 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 AzureBlobStorageLinkedService object itself.

      • getAccountKind

        public String getAccountKind()
        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.

      • setAccountKind

        public AzureBlobStorageLinkedService setAccountKind​(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.

      • getEncryptedCredential

        public String 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 AzureBlobStorageLinkedService setEncryptedCredential​(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.

      • setAnnotations

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