AzureBlobStorageLinkedService Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.0.0-beta.28

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.LinkedService
  • • com.azure.resourcemanager.datafactory.models.AzureBlobStorageLinkedService

public final 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	accountKey() Get the accountKey property: The Azure key vault secret reference of accountKey in connection string.
Object	accountKind() Get the accountKind property: Specify the kind of your storage account.
AzureStorageAuthenticationType	authenticationType() Get the authenticationType property: The type used for authentication.
Object	azureCloudType() Get the azureCloudType property: Indicates the azure cloud type of the service principle auth.
Object	connectionString() Get the connectionString property: The connection string.
Object	containerUri() Get the containerUri property: Container uri of the Azure Blob Storage resource only support for anonymous access.
CredentialReference	credential() Get the credential property: The credential reference containing authentication information.
String	encryptedCredential() Get the encryptedCredential property: The encrypted credential used for authentication.
AzureKeyVaultSecretReference	sasToken() Get the sasToken property: The Azure key vault secret reference of sasToken in sas uri.
Object	sasUri() Get the sasUri property: SAS URI of the Azure Blob Storage resource.
Object	serviceEndpoint() Get the serviceEndpoint property: Blob service endpoint of the Azure Blob Storage resource.
Object	servicePrincipalId() Get the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Data Warehouse.
SecretBase	servicePrincipalKey() Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Data Warehouse.
Object	tenant() Get the tenant property: The name or ID of the tenant to which the service principal belongs.
String	type() Get the type property: Type of linked service.
void	validate() Validates the instance.
AzureBlobStorageLinkedService	withAccountKey(AzureKeyVaultSecretReference accountKey) Set the accountKey property: The Azure key vault secret reference of accountKey in connection string.
AzureBlobStorageLinkedService	withAccountKind(Object accountKind) Set the accountKind property: Specify the kind of your storage account.
AzureBlobStorageLinkedService	withAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.
AzureBlobStorageLinkedService	withAuthenticationType(AzureStorageAuthenticationType authenticationType) Set the authenticationType property: The type used for authentication.
AzureBlobStorageLinkedService	withAzureCloudType(Object azureCloudType) Set the azureCloudType property: Indicates the azure cloud type of the service principle auth.
AzureBlobStorageLinkedService	withConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
AzureBlobStorageLinkedService	withConnectionString(Object connectionString) Set the connectionString property: The connection string.
AzureBlobStorageLinkedService	withContainerUri(Object containerUri) Set the containerUri property: Container uri of the Azure Blob Storage resource only support for anonymous access.
AzureBlobStorageLinkedService	withCredential(CredentialReference credential) Set the credential property: The credential reference containing authentication information.
AzureBlobStorageLinkedService	withDescription(String description) Set the description property: Linked service description.
AzureBlobStorageLinkedService	withEncryptedCredential(String encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.
AzureBlobStorageLinkedService	withParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.
AzureBlobStorageLinkedService	withSasToken(AzureKeyVaultSecretReference sasToken) Set the sasToken property: The Azure key vault secret reference of sasToken in sas uri.
AzureBlobStorageLinkedService	withSasUri(Object sasUri) Set the sasUri property: SAS URI of the Azure Blob Storage resource.
AzureBlobStorageLinkedService	withServiceEndpoint(Object serviceEndpoint) Set the serviceEndpoint property: Blob service endpoint of the Azure Blob Storage resource.
AzureBlobStorageLinkedService	withServicePrincipalId(Object servicePrincipalId) Set the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Data Warehouse.
AzureBlobStorageLinkedService	withServicePrincipalKey(SecretBase servicePrincipalKey) Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Data Warehouse.
AzureBlobStorageLinkedService	withTenant(Object tenant) Set the tenant property: The name or ID of the tenant to which the service principal belongs.

Methods inherited from LinkedService

additionalProperties annotations connectVia description parameters type validate withAdditionalProperties withAnnotations withConnectVia withDescription withParameters

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

accountKey

public AzureKeyVaultSecretReference accountKey()

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

Returns:

the accountKey value.

accountKind

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

authenticationType

public AzureStorageAuthenticationType authenticationType()

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

Returns:

the authenticationType value.

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

Returns:

the azureCloudType value.

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.

containerUri

public Object containerUri()

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.

credential

public CredentialReference credential()

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

Returns:

the credential value.

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.

Returns:

the encryptedCredential value.

sasToken

public AzureKeyVaultSecretReference sasToken()

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

Returns:

the sasToken value.

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.

serviceEndpoint

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

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.

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.

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.

type

public String type()

Get the type property: Type of linked service.

Overrides:

AzureBlobStorageLinkedService.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AzureBlobStorageLinkedService.validate()

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.

withAccountKind

public AzureBlobStorageLinkedService withAccountKind(Object 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.

withAnnotations

public AzureBlobStorageLinkedService withAnnotations(List

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

Overrides:

AzureBlobStorageLinkedService.withAnnotations(List<Object> annotations)

Parameters:

annotations

withAuthenticationType

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

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

Parameters:

azureCloudType - the azureCloudType value to set.

Returns:

the AzureBlobStorageLinkedService object itself.

withConnectVia

public AzureBlobStorageLinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

AzureBlobStorageLinkedService.withConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

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.

withContainerUri

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

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.

withDescription

public AzureBlobStorageLinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

AzureBlobStorageLinkedService.withDescription(String description)

Parameters:

description

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.

Parameters:

encryptedCredential - the encryptedCredential value to set.

Returns:

the AzureBlobStorageLinkedService object itself.

withParameters

public AzureBlobStorageLinkedService withParameters(Map parameters)

Set the parameters property: Parameters for linked service.

Overrides:

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

Parameters:

parameters

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.

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.

withServiceEndpoint

public AzureBlobStorageLinkedService withServiceEndpoint(Object 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.

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.

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.

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.