AzureSqlMILinkedService 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.AzureSqlMILinkedService

public final class AzureSqlMILinkedService
extends LinkedService

Azure SQL Managed Instance linked service.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
SqlAlwaysEncryptedProperties	alwaysEncryptedSettings() Get the alwaysEncryptedSettings property: Sql always encrypted properties.
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.
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	password() Get the password property: The Azure key vault secret reference of password in connection string.
Object	servicePrincipalId() Get the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Managed Instance.
SecretBase	servicePrincipalKey() Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Managed Instance.
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.
AzureSqlMILinkedService	withAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings) Set the alwaysEncryptedSettings property: Sql always encrypted properties.
AzureSqlMILinkedService	withAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.
AzureSqlMILinkedService	withAzureCloudType(Object azureCloudType) Set the azureCloudType property: Indicates the azure cloud type of the service principle auth.
AzureSqlMILinkedService	withConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
AzureSqlMILinkedService	withConnectionString(Object connectionString) Set the connectionString property: The connection string.
AzureSqlMILinkedService	withCredential(CredentialReference credential) Set the credential property: The credential reference containing authentication information.
AzureSqlMILinkedService	withDescription(String description) Set the description property: Linked service description.
AzureSqlMILinkedService	withEncryptedCredential(String encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.
AzureSqlMILinkedService	withParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.
AzureSqlMILinkedService	withPassword(AzureKeyVaultSecretReference password) Set the password property: The Azure key vault secret reference of password in connection string.
AzureSqlMILinkedService	withServicePrincipalId(Object servicePrincipalId) Set the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Managed Instance.
AzureSqlMILinkedService	withServicePrincipalKey(SecretBase servicePrincipalKey) Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Managed Instance.
AzureSqlMILinkedService	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

AzureSqlMILinkedService

public AzureSqlMILinkedService()

Creates an instance of AzureSqlMILinkedService class.

Method Details

alwaysEncryptedSettings

public SqlAlwaysEncryptedProperties alwaysEncryptedSettings()

Get the alwaysEncryptedSettings property: Sql always encrypted properties.

Returns:

the alwaysEncryptedSettings 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. Type: string, SecureString or AzureKeyVaultSecretReference.

Returns:

the connectionString 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.

password

public AzureKeyVaultSecretReference password()

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

Returns:

the password value.

servicePrincipalId

public Object servicePrincipalId()

Get the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Managed Instance. 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 Managed Instance.

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:

AzureSqlMILinkedService.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AzureSqlMILinkedService.validate()

withAlwaysEncryptedSettings

public AzureSqlMILinkedService withAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)

Set the alwaysEncryptedSettings property: Sql always encrypted properties.

Parameters:

alwaysEncryptedSettings - the alwaysEncryptedSettings value to set.

Returns:

the AzureSqlMILinkedService object itself.

withAnnotations

public AzureSqlMILinkedService withAnnotations(List

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

Overrides:

AzureSqlMILinkedService.withAnnotations(List<Object> annotations)

Parameters:

annotations

withAzureCloudType

public AzureSqlMILinkedService 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 AzureSqlMILinkedService object itself.

withConnectVia

public AzureSqlMILinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

AzureSqlMILinkedService.withConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

withConnectionString

public AzureSqlMILinkedService withConnectionString(Object connectionString)

Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Parameters:

connectionString - the connectionString value to set.

Returns:

the AzureSqlMILinkedService object itself.

withCredential

public AzureSqlMILinkedService withCredential(CredentialReference credential)

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

Parameters:

credential - the credential value to set.

Returns:

the AzureSqlMILinkedService object itself.

withDescription

public AzureSqlMILinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

AzureSqlMILinkedService.withDescription(String description)

Parameters:

description

withEncryptedCredential

public AzureSqlMILinkedService 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 AzureSqlMILinkedService object itself.

withParameters

public AzureSqlMILinkedService withParameters(Map parameters)

Set the parameters property: Parameters for linked service.

Overrides:

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

Parameters:

parameters

withPassword

public AzureSqlMILinkedService withPassword(AzureKeyVaultSecretReference password)

Set the password property: The Azure key vault secret reference of password in connection string.

Parameters:

password - the password value to set.

Returns:

the AzureSqlMILinkedService object itself.

withServicePrincipalId

public AzureSqlMILinkedService withServicePrincipalId(Object servicePrincipalId)

Set the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).

Parameters:

servicePrincipalId - the servicePrincipalId value to set.

Returns:

the AzureSqlMILinkedService object itself.

withServicePrincipalKey

public AzureSqlMILinkedService withServicePrincipalKey(SecretBase servicePrincipalKey)

Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Managed Instance.

Parameters:

servicePrincipalKey - the servicePrincipalKey value to set.

Returns:

the AzureSqlMILinkedService object itself.

withTenant

public AzureSqlMILinkedService 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 AzureSqlMILinkedService object itself.