AzureSqlMILinkedServiceTypeProperties Class
- java.
lang. Object - com.
azure. resourcemanager. datafactory. models. SqlServerBaseLinkedServiceTypeProperties - com.
azure. resourcemanager. datafactory. fluent. models. AzureSqlMILinkedServiceTypeProperties
- com.
- com.
public final class AzureSqlMILinkedServiceTypeProperties
extends SqlServerBaseLinkedServiceTypeProperties
Azure SQL Managed Instance linked service properties.
Constructor Summary
| Constructor | Description |
|---|---|
| AzureSqlMILinkedServiceTypeProperties() |
Creates an instance of Azure |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
Sql |
alwaysEncryptedSettings()
Get the always |
|
Azure |
authenticationType()
Get the authentication |
| Object |
azureCloudType()
Get the azure |
| Object |
connectionString()
Get the connection |
|
Credential |
credential()
Get the credential property: The credential reference containing authentication information. |
| String |
encryptedCredential()
Get the encrypted |
|
static
Azure |
fromJson(JsonReader jsonReader)
Reads an instance of Azure |
|
Azure |
password()
Get the password property: The Azure key vault secret reference of password in connection string. |
|
Secret |
servicePrincipalCredential()
Get the service |
| Object |
servicePrincipalCredentialType()
Get the service |
| Object |
servicePrincipalId()
Get the service |
|
Secret |
servicePrincipalKey()
Get the service |
| Object |
tenant()
Get the tenant property: The name or ID of the tenant to which the service principal belongs. |
|
Json |
toJson(JsonWriter jsonWriter) |
| Object |
username()
Get the username property: The user name to be used when connecting to server. |
| void |
validate()
Validates the instance. |
|
Azure |
withAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)
Set the always |
|
Azure |
withApplicationIntent(Object applicationIntent)
Set the application |
|
Azure |
withAuthenticationType(AzureSqlMIAuthenticationType authenticationType)
Set the authentication |
|
Azure |
withAzureCloudType(Object azureCloudType)
Set the azure |
|
Azure |
withCommandTimeout(Object commandTimeout)
Set the command |
|
Azure |
withConnectionString(Object connectionString)
Set the connection |
|
Azure |
withConnectRetryCount(Object connectRetryCount)
Set the connect |
|
Azure |
withConnectRetryInterval(Object connectRetryInterval)
Set the connect |
|
Azure |
withConnectTimeout(Object connectTimeout)
Set the connect |
|
Azure |
withCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information. |
|
Azure |
withDatabase(Object database)
Set the database property: The name of the database, used by recommended version. |
|
Azure |
withEncrypt(Object encrypt)
Set the encrypt property: Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. |
|
Azure |
withEncryptedCredential(String encryptedCredential)
Set the encrypted |
|
Azure |
withFailoverPartner(Object failoverPartner)
Set the failover |
|
Azure |
withHostnameInCertificate(Object hostnameInCertificate)
Set the hostname |
|
Azure |
withIntegratedSecurity(Object integratedSecurity)
Set the integrated |
|
Azure |
withLoadBalanceTimeout(Object loadBalanceTimeout)
Set the load |
|
Azure |
withMaxPoolSize(Object maxPoolSize)
Set the max |
|
Azure |
withMinPoolSize(Object minPoolSize)
Set the min |
|
Azure |
withMultipleActiveResultSets(Object multipleActiveResultSets)
Set the multiple |
|
Azure |
withMultiSubnetFailover(Object multiSubnetFailover)
Set the multi |
|
Azure |
withPacketSize(Object packetSize)
Set the packet |
|
Azure |
withPassword(AzureKeyVaultSecretReference password)
Set the password property: The Azure key vault secret reference of password in connection string. |
|
Azure |
withPooling(Object pooling)
Set the pooling property: Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. |
|
Azure |
withServer(Object server)
Set the server property: The name or network address of the instance of SQL Server to which to connect, used by recommended version. |
|
Azure |
withServicePrincipalCredential(SecretBase servicePrincipalCredential)
Set the service |
|
Azure |
withServicePrincipalCredentialType(Object servicePrincipalCredentialType)
Set the service |
|
Azure |
withServicePrincipalId(Object servicePrincipalId)
Set the service |
|
Azure |
withServicePrincipalKey(SecretBase servicePrincipalKey)
Set the service |
|
Azure |
withTenant(Object tenant)
Set the tenant property: The name or ID of the tenant to which the service principal belongs. |
|
Azure |
withTrustServerCertificate(Object trustServerCertificate)
Set the trust |
|
Azure |
withUsername(Object username)
Set the username property: The user name to be used when connecting to server. |
Methods inherited from SqlServerBaseLinkedServiceTypeProperties
Methods inherited from java.lang.Object
Constructor Details
AzureSqlMILinkedServiceTypeProperties
public AzureSqlMILinkedServiceTypeProperties()
Creates an instance of AzureSqlMILinkedServiceTypeProperties class.
Method Details
alwaysEncryptedSettings
public SqlAlwaysEncryptedProperties alwaysEncryptedSettings()
Get the alwaysEncryptedSettings property: Sql always encrypted properties.
Returns:
authenticationType
public AzureSqlMIAuthenticationType authenticationType()
Get the authenticationType property: The type used for authentication. Type: string.
Returns:
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:
connectionString
public Object connectionString()
Get the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
Returns:
credential
public CredentialReference credential()
Get the credential property: The credential reference containing authentication information.
Returns:
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:
fromJson
public static AzureSqlMILinkedServiceTypeProperties fromJson(JsonReader jsonReader)
Reads an instance of AzureSqlMILinkedServiceTypeProperties from the JsonReader.
Parameters:
Returns:
Throws:
password
public AzureKeyVaultSecretReference password()
Get the password property: The Azure key vault secret reference of password in connection string.
Returns:
servicePrincipalCredential
public SecretBase servicePrincipalCredential()
Get the servicePrincipalCredential property: The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
Returns:
servicePrincipalCredentialType
public Object servicePrincipalCredentialType()
Get the servicePrincipalCredentialType property: The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
Returns:
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:
servicePrincipalKey
public SecretBase servicePrincipalKey()
Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Managed Instance.
Returns:
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:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
AzureSqlMILinkedServiceTypeProperties.toJson(JsonWriter jsonWriter)Parameters:
Throws:
username
public Object username()
Get the username property: The user name to be used when connecting to server. Type: string (or Expression with resultType string).
Returns:
validate
public void validate()
Validates the instance.
Overrides:
AzureSqlMILinkedServiceTypeProperties.validate()withAlwaysEncryptedSettings
public AzureSqlMILinkedServiceTypeProperties withAlwaysEncryptedSettings(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)
Set the alwaysEncryptedSettings property: Sql always encrypted properties.
Parameters:
Returns:
withApplicationIntent
public AzureSqlMILinkedServiceTypeProperties withApplicationIntent(Object applicationIntent)
Set the applicationIntent property: The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withApplicationIntent(Object applicationIntent)Parameters:
withAuthenticationType
public AzureSqlMILinkedServiceTypeProperties withAuthenticationType(AzureSqlMIAuthenticationType authenticationType)
Set the authenticationType property: The type used for authentication. Type: string.
Parameters:
Returns:
withAzureCloudType
public AzureSqlMILinkedServiceTypeProperties 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:
Returns:
withCommandTimeout
public AzureSqlMILinkedServiceTypeProperties withCommandTimeout(Object commandTimeout)
Set the commandTimeout property: The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withCommandTimeout(Object commandTimeout)Parameters:
withConnectionString
public AzureSqlMILinkedServiceTypeProperties withConnectionString(Object connectionString)
Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
Parameters:
Returns:
withConnectRetryCount
public AzureSqlMILinkedServiceTypeProperties withConnectRetryCount(Object connectRetryCount)
Set the connectRetryCount property: The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withConnectRetryCount(Object connectRetryCount)Parameters:
withConnectRetryInterval
public AzureSqlMILinkedServiceTypeProperties withConnectRetryInterval(Object connectRetryInterval)
Set the connectRetryInterval property: The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withConnectRetryInterval(Object connectRetryInterval)Parameters:
withConnectTimeout
public AzureSqlMILinkedServiceTypeProperties withConnectTimeout(Object connectTimeout)
Set the connectTimeout property: The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withConnectTimeout(Object connectTimeout)Parameters:
withCredential
public AzureSqlMILinkedServiceTypeProperties withCredential(CredentialReference credential)
Set the credential property: The credential reference containing authentication information.
Parameters:
Returns:
withDatabase
public AzureSqlMILinkedServiceTypeProperties withDatabase(Object database)
Set the database property: The name of the database, used by recommended version. Type: string (or Expression with resultType string).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withDatabase(Object database)Parameters:
withEncrypt
public AzureSqlMILinkedServiceTypeProperties withEncrypt(Object encrypt)
Set the encrypt property: Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withEncrypt(Object encrypt)Parameters:
withEncryptedCredential
public AzureSqlMILinkedServiceTypeProperties 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:
Returns:
withFailoverPartner
public AzureSqlMILinkedServiceTypeProperties withFailoverPartner(Object failoverPartner)
Set the failoverPartner property: The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withFailoverPartner(Object failoverPartner)Parameters:
withHostnameInCertificate
public AzureSqlMILinkedServiceTypeProperties withHostnameInCertificate(Object hostnameInCertificate)
Set the hostnameInCertificate property: The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withHostnameInCertificate(Object hostnameInCertificate)Parameters:
withIntegratedSecurity
public AzureSqlMILinkedServiceTypeProperties withIntegratedSecurity(Object integratedSecurity)
Set the integratedSecurity property: Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withIntegratedSecurity(Object integratedSecurity)Parameters:
withLoadBalanceTimeout
public AzureSqlMILinkedServiceTypeProperties withLoadBalanceTimeout(Object loadBalanceTimeout)
Set the loadBalanceTimeout property: The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withLoadBalanceTimeout(Object loadBalanceTimeout)Parameters:
withMaxPoolSize
public AzureSqlMILinkedServiceTypeProperties withMaxPoolSize(Object maxPoolSize)
Set the maxPoolSize property: The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withMaxPoolSize(Object maxPoolSize)Parameters:
withMinPoolSize
public AzureSqlMILinkedServiceTypeProperties withMinPoolSize(Object minPoolSize)
Set the minPoolSize property: The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withMinPoolSize(Object minPoolSize)Parameters:
withMultipleActiveResultSets
public AzureSqlMILinkedServiceTypeProperties withMultipleActiveResultSets(Object multipleActiveResultSets)
Set the multipleActiveResultSets property: When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withMultipleActiveResultSets(Object multipleActiveResultSets)Parameters:
withMultiSubnetFailover
public AzureSqlMILinkedServiceTypeProperties withMultiSubnetFailover(Object multiSubnetFailover)
Set the multiSubnetFailover property: If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withMultiSubnetFailover(Object multiSubnetFailover)Parameters:
withPacketSize
public AzureSqlMILinkedServiceTypeProperties withPacketSize(Object packetSize)
Set the packetSize property: The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withPacketSize(Object packetSize)Parameters:
withPassword
public AzureSqlMILinkedServiceTypeProperties withPassword(AzureKeyVaultSecretReference password)
Set the password property: The Azure key vault secret reference of password in connection string.
Parameters:
Returns:
withPooling
public AzureSqlMILinkedServiceTypeProperties withPooling(Object pooling)
Set the pooling property: Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withPooling(Object pooling)Parameters:
withServer
public AzureSqlMILinkedServiceTypeProperties withServer(Object server)
Set the server property: The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withServer(Object server)Parameters:
withServicePrincipalCredential
public AzureSqlMILinkedServiceTypeProperties withServicePrincipalCredential(SecretBase servicePrincipalCredential)
Set the servicePrincipalCredential property: The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
Parameters:
Returns:
withServicePrincipalCredentialType
public AzureSqlMILinkedServiceTypeProperties withServicePrincipalCredentialType(Object servicePrincipalCredentialType)
Set the servicePrincipalCredentialType property: The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
Parameters:
Returns:
withServicePrincipalId
public AzureSqlMILinkedServiceTypeProperties 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:
Returns:
withServicePrincipalKey
public AzureSqlMILinkedServiceTypeProperties withServicePrincipalKey(SecretBase servicePrincipalKey)
Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Managed Instance.
Parameters:
Returns:
withTenant
public AzureSqlMILinkedServiceTypeProperties 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:
Returns:
withTrustServerCertificate
public AzureSqlMILinkedServiceTypeProperties withTrustServerCertificate(Object trustServerCertificate)
Set the trustServerCertificate property: Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).
Overrides:
AzureSqlMILinkedServiceTypeProperties.withTrustServerCertificate(Object trustServerCertificate)Parameters:
withUsername
public AzureSqlMILinkedServiceTypeProperties withUsername(Object username)
Set the username property: The user name to be used when connecting to server. Type: string (or Expression with resultType string).
Parameters:
Returns: