AzureSqlMILinkedService.yml

### YamlMime:TSType
name: AzureSqlMILinkedService
uid: '@azure/arm-datafactory.AzureSqlMILinkedService'
package: '@azure/arm-datafactory'
summary: Azure SQL Managed Instance linked service.
fullName: AzureSqlMILinkedService
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: alwaysEncryptedSettings
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.alwaysEncryptedSettings'
    package: '@azure/arm-datafactory'
    summary: Sql always encrypted properties.
    fullName: alwaysEncryptedSettings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'alwaysEncryptedSettings?: SqlAlwaysEncryptedProperties'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.SqlAlwaysEncryptedProperties" />
  - name: applicationIntent
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.applicationIntent'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: applicationIntent
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'applicationIntent?: any'
      return:
        description: ''
        type: any
  - name: authenticationType
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.authenticationType'
    package: '@azure/arm-datafactory'
    summary: 'The type used for authentication. Type: string.'
    fullName: authenticationType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'authenticationType?: string'
      return:
        description: ''
        type: string
  - name: azureCloudType
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.azureCloudType'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: azureCloudType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'azureCloudType?: any'
      return:
        description: ''
        type: any
  - name: commandTimeout
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.commandTimeout'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: commandTimeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'commandTimeout?: any'
      return:
        description: ''
        type: any
  - name: connectionString
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.connectionString'
    package: '@azure/arm-datafactory'
    summary: >-
      The connection string. Type: string, SecureString or
      AzureKeyVaultSecretReference.
    fullName: connectionString
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'connectionString?: any'
      return:
        description: ''
        type: any
  - name: connectRetryCount
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.connectRetryCount'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: connectRetryCount
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'connectRetryCount?: any'
      return:
        description: ''
        type: any
  - name: connectRetryInterval
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.connectRetryInterval'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: connectRetryInterval
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'connectRetryInterval?: any'
      return:
        description: ''
        type: any
  - name: connectTimeout
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.connectTimeout'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: connectTimeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'connectTimeout?: any'
      return:
        description: ''
        type: any
  - name: credential
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.credential'
    package: '@azure/arm-datafactory'
    summary: The credential reference containing authentication information.
    fullName: credential
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'credential?: CredentialReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.CredentialReference" />
  - name: database
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.database'
    package: '@azure/arm-datafactory'
    summary: >-
      The name of the database, used by recommended version. Type: string (or
      Expression with resultType string).
    fullName: database
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'database?: any'
      return:
        description: ''
        type: any
  - name: encrypt
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.encrypt'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: encrypt
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'encrypt?: any'
      return:
        description: ''
        type: any
  - name: encryptedCredential
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.encryptedCredential'
    package: '@azure/arm-datafactory'
    summary: >-
      The encrypted credential used for authentication. Credentials are
      encrypted using the integration runtime credential manager. Type: string.
    fullName: encryptedCredential
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'encryptedCredential?: string'
      return:
        description: ''
        type: string
  - name: failoverPartner
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.failoverPartner'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: failoverPartner
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'failoverPartner?: any'
      return:
        description: ''
        type: any
  - name: hostNameInCertificate
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.hostNameInCertificate'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: hostNameInCertificate
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'hostNameInCertificate?: any'
      return:
        description: ''
        type: any
  - name: integratedSecurity
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.integratedSecurity'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: integratedSecurity
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'integratedSecurity?: any'
      return:
        description: ''
        type: any
  - name: loadBalanceTimeout
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.loadBalanceTimeout'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: loadBalanceTimeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'loadBalanceTimeout?: any'
      return:
        description: ''
        type: any
  - name: maxPoolSize
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.maxPoolSize'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: maxPoolSize
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'maxPoolSize?: any'
      return:
        description: ''
        type: any
  - name: minPoolSize
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.minPoolSize'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: minPoolSize
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'minPoolSize?: any'
      return:
        description: ''
        type: any
  - name: multipleActiveResultSets
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.multipleActiveResultSets'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: multipleActiveResultSets
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'multipleActiveResultSets?: any'
      return:
        description: ''
        type: any
  - name: multiSubnetFailover
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.multiSubnetFailover'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: multiSubnetFailover
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'multiSubnetFailover?: any'
      return:
        description: ''
        type: any
  - name: packetSize
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.packetSize'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: packetSize
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'packetSize?: any'
      return:
        description: ''
        type: any
  - name: password
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.password'
    package: '@azure/arm-datafactory'
    summary: The Azure key vault secret reference of password in connection string.
    fullName: password
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'password?: AzureKeyVaultSecretReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.AzureKeyVaultSecretReference" />
  - name: pooling
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.pooling'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: pooling
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'pooling?: any'
      return:
        description: ''
        type: any
  - name: server
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.server'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: server
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'server?: any'
      return:
        description: ''
        type: any
  - name: servicePrincipalCredential
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.servicePrincipalCredential'
    package: '@azure/arm-datafactory'
    summary: >-
      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.
    fullName: servicePrincipalCredential
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'servicePrincipalCredential?: SecretBaseUnion'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.SecretBaseUnion" />
  - name: servicePrincipalCredentialType
    uid: >-
      @azure/arm-datafactory.AzureSqlMILinkedService.servicePrincipalCredentialType
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: servicePrincipalCredentialType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'servicePrincipalCredentialType?: any'
      return:
        description: ''
        type: any
  - name: servicePrincipalId
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.servicePrincipalId'
    package: '@azure/arm-datafactory'
    summary: >-
      The ID of the service principal used to authenticate against Azure SQL
      Managed Instance. Type: string (or Expression with resultType string).
    fullName: servicePrincipalId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'servicePrincipalId?: any'
      return:
        description: ''
        type: any
  - name: servicePrincipalKey
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.servicePrincipalKey'
    package: '@azure/arm-datafactory'
    summary: >-
      The key of the service principal used to authenticate against Azure SQL
      Managed Instance.
    fullName: servicePrincipalKey
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'servicePrincipalKey?: SecretBaseUnion'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.SecretBaseUnion" />
  - name: tenant
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.tenant'
    package: '@azure/arm-datafactory'
    summary: >-
      The name or ID of the tenant to which the service principal belongs. Type:
      string (or Expression with resultType string).
    fullName: tenant
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tenant?: any'
      return:
        description: ''
        type: any
  - name: trustServerCertificate
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.trustServerCertificate'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: trustServerCertificate
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'trustServerCertificate?: any'
      return:
        description: ''
        type: any
  - name: type
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.type'
    package: '@azure/arm-datafactory'
    summary: >-
      Polymorphic discriminator, which specifies the different types this object
      can be
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type: "AzureSqlMI"'
      return:
        description: ''
        type: '"AzureSqlMI"'
  - name: userName
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.userName'
    package: '@azure/arm-datafactory'
    summary: >-
      The user name to be used when connecting to server. Type: string (or
      Expression with resultType string).
    fullName: userName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userName?: any'
      return:
        description: ''
        type: any
inheritedProperties:
  - name: annotations
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.annotations'
    package: '@azure/arm-datafactory'
    summary: List of tags that can be used for describing the linked service.
    fullName: annotations
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'annotations?: any[]'
      return:
        description: ''
        type: any[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.annotations](xref:@azure/arm-datafactory.LinkedService.annotations)
  - name: connectVia
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.connectVia'
    package: '@azure/arm-datafactory'
    summary: The integration runtime reference.
    fullName: connectVia
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'connectVia?: IntegrationRuntimeReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.IntegrationRuntimeReference" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.connectVia](xref:@azure/arm-datafactory.LinkedService.connectVia)
  - name: description
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.description'
    package: '@azure/arm-datafactory'
    summary: Linked service description.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.description](xref:@azure/arm-datafactory.LinkedService.description)
  - name: parameters
    uid: '@azure/arm-datafactory.AzureSqlMILinkedService.parameters'
    package: '@azure/arm-datafactory'
    summary: Parameters for linked service.
    fullName: parameters
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'parameters?: {[propertyName: string]: ParameterSpecification}'
      return:
        description: ''
        type: >-
          {[propertyName: string]: <xref
          uid="@azure/arm-datafactory.ParameterSpecification" />}
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.parameters](xref:@azure/arm-datafactory.LinkedService.parameters)
extends: <xref uid="@azure/arm-datafactory.LinkedService" />