AzureBlobStorageLinkedService Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.models.LinkedService
  • • com.azure.analytics.synapse.artifacts.models.AzureBlobStorageLinkedService

public class AzureBlobStorageLinkedService
extends LinkedService

The azure blob storage linked service.

Constructor Summary

Constructor	Description
AzureBlobStorageLinkedService()	Creates an instance of AzureBlobStorageLinkedService class.

Method Summary

Modifier and Type	Method and Description
AzureKeyVaultSecretReference	getAccountKey() Get the accountKey property: The Azure key vault secret reference of accountKey in connection string.
String	getAccountKind() Get the accountKind property: Specify the kind of your storage account.
AzureStorageAuthenticationType	getAuthenticationType() Get the authenticationType property: The type used for authentication.
Object	getAzureCloudType() Get the azureCloudType property: Indicates the azure cloud type of the service principle auth.
Object	getConnectionString() Get the connectionString property: The connection string.
Object	getContainerUri() Get the containerUri property: Container uri of the Azure Blob Storage resource only support for anonymous access.
CredentialReference	getCredential() Get the credential property: The credential reference containing authentication information.
String	getEncryptedCredential() Get the encryptedCredential property: The encrypted credential used for authentication.
AzureKeyVaultSecretReference	getSasToken() Get the sasToken property: The Azure key vault secret reference of sasToken in sas uri.
Object	getSasUri() Get the sasUri property: SAS URI of the Azure Blob Storage resource.
String	getServiceEndpoint() Get the serviceEndpoint property: Blob service endpoint of the Azure Blob Storage resource.
Object	getServicePrincipalId() Get the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Data Warehouse.
SecretBase	getServicePrincipalKey() Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Data Warehouse.
Object	getTenant() Get the tenant property: The name or ID of the tenant to which the service principal belongs.
AzureBlobStorageLinkedService	setAccountKey(AzureKeyVaultSecretReference accountKey) Set the accountKey property: The Azure key vault secret reference of accountKey in connection string.
AzureBlobStorageLinkedService	setAccountKind(String accountKind) Set the accountKind property: Specify the kind of your storage account.
AzureBlobStorageLinkedService	setAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.
AzureBlobStorageLinkedService	setAuthenticationType(AzureStorageAuthenticationType authenticationType) Set the authenticationType property: The type used for authentication.
AzureBlobStorageLinkedService	setAzureCloudType(Object azureCloudType) Set the azureCloudType property: Indicates the azure cloud type of the service principle auth.
AzureBlobStorageLinkedService	setConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
AzureBlobStorageLinkedService	setConnectionString(Object connectionString) Set the connectionString property: The connection string.
AzureBlobStorageLinkedService	setContainerUri(Object containerUri) Set the containerUri property: Container uri of the Azure Blob Storage resource only support for anonymous access.
AzureBlobStorageLinkedService	setCredential(CredentialReference credential) Set the credential property: The credential reference containing authentication information.
AzureBlobStorageLinkedService	setDescription(String description) Set the description property: Linked service description.
AzureBlobStorageLinkedService	setEncryptedCredential(String encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.
AzureBlobStorageLinkedService	setParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.
AzureBlobStorageLinkedService	setSasToken(AzureKeyVaultSecretReference sasToken) Set the sasToken property: The Azure key vault secret reference of sasToken in sas uri.
AzureBlobStorageLinkedService	setSasUri(Object sasUri) Set the sasUri property: SAS URI of the Azure Blob Storage resource.
AzureBlobStorageLinkedService	setServiceEndpoint(String serviceEndpoint) Set the serviceEndpoint property: Blob service endpoint of the Azure Blob Storage resource.
AzureBlobStorageLinkedService	setServicePrincipalId(Object servicePrincipalId) Set the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Data Warehouse.
AzureBlobStorageLinkedService	setServicePrincipalKey(SecretBase servicePrincipalKey) Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Data Warehouse.
AzureBlobStorageLinkedService	setTenant(Object tenant) Set the tenant property: The name or ID of the tenant to which the service principal belongs.

Methods inherited from LinkedService

getAdditionalProperties getAnnotations getConnectVia getDescription getParameters setAdditionalProperties setAnnotations setConnectVia setDescription setParameters

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureBlobStorageLinkedService

public AzureBlobStorageLinkedService()

Creates an instance of AzureBlobStorageLinkedService class.

Method Details

getAccountKey

public AzureKeyVaultSecretReference getAccountKey()

Get the accountKey property: The Azure key vault secret reference of accountKey in connection string.

Returns:

the accountKey value.

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.

getAuthenticationType

public AzureStorageAuthenticationType getAuthenticationType()

Get the authenticationType property: The type used for authentication. Type: string.

Returns:

the authenticationType value.

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\u2019 cloud type. Type: string (or Expression with resultType string).

Returns:

the azureCloudType value.

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.

getContainerUri

public Object getContainerUri()

Get the containerUri property: Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string).

Returns:

the containerUri value.

getCredential

public CredentialReference getCredential()

Get the credential property: The credential reference containing authentication information.

Returns:

the credential value.

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.

getSasToken

public AzureKeyVaultSecretReference getSasToken()

Get the sasToken property: The Azure key vault secret reference of sasToken in sas uri.

Returns:

the sasToken value.

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.

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.

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.

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.

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.

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.

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.

setAnnotations

public AzureBlobStorageLinkedService setAnnotations(List

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

AzureBlobStorageLinkedService.setAnnotations(List<Object> annotations)

Parameters:

annotations

setAuthenticationType

public AzureBlobStorageLinkedService setAuthenticationType(AzureStorageAuthenticationType authenticationType)

Set the authenticationType property: The type used for authentication. Type: string.

Parameters:

authenticationType - the authenticationType value to set.

Returns:

the AzureBlobStorageLinkedService object itself.

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\u2019 cloud type. Type: string (or Expression with resultType string).

Parameters:

azureCloudType - the azureCloudType value to set.

Returns:

the AzureBlobStorageLinkedService object itself.

setConnectVia

public AzureBlobStorageLinkedService setConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

AzureBlobStorageLinkedService.setConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

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.

setContainerUri

public AzureBlobStorageLinkedService setContainerUri(Object containerUri)

Set the containerUri property: Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string).

Parameters:

containerUri - the containerUri value to set.

Returns:

the AzureBlobStorageLinkedService object itself.

setCredential

public AzureBlobStorageLinkedService setCredential(CredentialReference credential)

Set the credential property: The credential reference containing authentication information.

Parameters:

credential - the credential value to set.

Returns:

the AzureBlobStorageLinkedService object itself.

setDescription

public AzureBlobStorageLinkedService setDescription(String description)

Set the description property: Linked service description.

Overrides:

AzureBlobStorageLinkedService.setDescription(String description)

Parameters:

description

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.

setParameters

public AzureBlobStorageLinkedService setParameters(Map parameters)

Set the parameters property: Parameters for linked service.

Overrides:

AzureBlobStorageLinkedService.setParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

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.

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.

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.

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.

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.

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.