SqlServerLinkedService interface

パッケージ:

@azure/synapse-artifacts

SQL Server のリンクされたサービス。

Extends

LinkedService

プロパティ

alwaysEncryptedSettings	Sql は常に暗号化されたプロパティです。
applicationIntent	推奨バージョンで使用される、サーバーに接続するときのアプリケーション ワークロードの種類。 指定できる値は ReadOnly と ReadWrite です。 型: string (または resultType 文字列を含む式)。
authenticationType	認証に使用される型。 型: 文字列。
commandTimeout	コマンドの実行を終了し、推奨バージョンで使用されるエラーを生成するまでの既定の待機時間 (秒単位)。 型: 整数 (または resultType 整数を持つ式)。
connectionString	接続文字列。 型: string、SecureString、または AzureKeyVaultSecretReference。
connectRetryCount	推奨バージョンで使用される、アイドル状態の接続エラーが発生したことを識別した後に試行された再接続の数。 これは、0 から 255 までの整数である必要があります。 型: 整数 (または resultType 整数を持つ式)。
connectRetryInterval	推奨バージョンで使用されるアイドル状態の接続エラーが発生したことを特定した後の、各再接続試行の間の時間 (秒単位)。 1 ~ 60 の整数を指定する必要があります。 型: 整数 (または resultType 整数を持つ式)。
connectTimeout	サーバーへの接続を待機してから試行を終了し、推奨バージョンで使用されるエラーを生成するまでの時間 (秒単位)。 型: 整数 (または resultType 整数を持つ式)。
credential	認証情報を含む資格情報参照。
database	推奨バージョンで使用されるデータベースの名前。 型: string (または resultType 文字列を含む式)。
encrypt	推奨バージョンで使用される、クライアントとサーバーの間で送信されるすべてのデータに TLS 暗号化が必要かどうかを示します。 指定できる値は true/yes/mandatory、false/no/optional、strict です。 型: string (または resultType 文字列を含む式)。
encryptedCredential	認証に使用される暗号化された資格情報。 資格情報は、統合ランタイム資格情報マネージャーを使用して暗号化されます。 型: string (または resultType 文字列を含む式)。
failoverPartner	プライマリ サーバーがダウンしている場合に接続するパートナー サーバーの名前またはアドレス。推奨バージョンで使用されます。 型: string (または resultType 文字列を含む式)。
hostNameInCertificate	接続のサーバー証明書を検証するときに使用するホスト名。 指定しない場合、データ ソースのサーバー名は証明書の検証に使用され、推奨バージョンで使用されます。 型: string (または resultType 文字列を含む式)。
integratedSecurity	接続でユーザー ID とパスワードを指定するか (false の場合)、または現在の Windows アカウントの資格情報を認証に使用するか (true の場合)、推奨バージョンで使用するかを指定します。 型: Boolean (または resultType ブール値を持つ式)。
loadBalanceTimeout	推奨バージョンで使用される、破棄される前の接続プールに接続が存在する最小時間 (秒単位)。 型: 整数 (または resultType 整数を持つ式)。
maxPoolSize	推奨バージョンで使用される、この特定の接続文字列に対して接続プールで許可される接続の最大数。 型: 整数 (または resultType 整数を持つ式)。
minPoolSize	推奨バージョンで使用される、この特定の接続文字列に対して接続プールで許可される接続の最小数。 型: 整数 (または resultType 整数を持つ式)。
multipleActiveResultSets	true の場合、アプリケーションは複数のアクティブな結果セット (MARS) を維持できます。 false の場合、アプリケーションは、その接続で他のバッチを実行する前に、1 つのバッチからすべての結果セットを処理または取り消す必要があります。 型: Boolean (または resultType ブール値を持つ式)。
multiSubnetFailover	アプリケーションが異なるサブネット上の AlwaysOn 可用性グループ (AG) に接続している場合、MultiSubnetFailover=true を設定すると、推奨バージョンで使用される (現在) アクティブなサーバーの検出と接続が高速化されます。 型: Boolean (または resultType ブール値を持つ式)。
packetSize	推奨バージョンで使用される、サーバーのインスタンスとの通信に使用されるネットワーク パケットのサイズ (バイト単位)。 型: 整数 (または resultType 整数を持つ式)。
password	オンプレミスの Windows 認証パスワード。
pooling	推奨バージョンで使用される、接続が要求されるたびに接続をプールするか、明示的に開くかを指定します。 型: Boolean (または resultType ブール値を持つ式)。
server	推奨バージョンで使用される、接続先の SQL Server インスタンスの名前またはネットワーク アドレス。 型: string (または resultType 文字列を含む式)。
trustServerCertificate	推奨バージョンで使用される信頼を検証するために、証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。 型: Boolean (または resultType ブール値を持つ式)。
type	ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。
userName	オンプレミスの Windows 認証ユーザー名。 型: string (または resultType 文字列を含む式)。

継承されたプロパティ

annotations	リンクされたサービスの説明に使用できるタグの一覧。
connectVia	統合ランタイムリファレンス。
description	リンクされたサービスの説明。
parameters	リンクされたサービスのパラメーター。
version	リンクされたサービスのバージョン。

プロパティの詳細

alwaysEncryptedSettings

Sql は常に暗号化されたプロパティです。

alwaysEncryptedSettings?: SqlAlwaysEncryptedProperties

プロパティ値

SqlAlwaysEncryptedProperties

applicationIntent

推奨バージョンで使用される、サーバーに接続するときのアプリケーション ワークロードの種類。 指定できる値は ReadOnly と ReadWrite です。 型: string (または resultType 文字列を含む式)。

applicationIntent?: any

プロパティ値

any

authenticationType

認証に使用される型。 型: 文字列。

authenticationType?: string

プロパティ値

string

commandTimeout

コマンドの実行を終了し、推奨バージョンで使用されるエラーを生成するまでの既定の待機時間 (秒単位)。 型: 整数 (または resultType 整数を持つ式)。

commandTimeout?: any

プロパティ値

any

connectionString

接続文字列。 型: string、SecureString、または AzureKeyVaultSecretReference。

connectionString?: any

プロパティ値

any

connectRetryCount

推奨バージョンで使用される、アイドル状態の接続エラーが発生したことを識別した後に試行された再接続の数。 これは、0 から 255 までの整数である必要があります。 型: 整数 (または resultType 整数を持つ式)。

connectRetryCount?: any

プロパティ値

any

connectRetryInterval

推奨バージョンで使用されるアイドル状態の接続エラーが発生したことを特定した後の、各再接続試行の間の時間 (秒単位)。 1 ~ 60 の整数を指定する必要があります。 型: 整数 (または resultType 整数を持つ式)。

connectRetryInterval?: any

プロパティ値

any

connectTimeout

サーバーへの接続を待機してから試行を終了し、推奨バージョンで使用されるエラーを生成するまでの時間 (秒単位)。 型: 整数 (または resultType 整数を持つ式)。

connectTimeout?: any

プロパティ値

any

credential

認証情報を含む資格情報参照。

credential?: CredentialReference

プロパティ値

CredentialReference

database

推奨バージョンで使用されるデータベースの名前。 型: string (または resultType 文字列を含む式)。

database?: any

プロパティ値

any

encrypt

推奨バージョンで使用される、クライアントとサーバーの間で送信されるすべてのデータに TLS 暗号化が必要かどうかを示します。 指定できる値は true/yes/mandatory、false/no/optional、strict です。 型: string (または resultType 文字列を含む式)。

encrypt?: any

プロパティ値

any

encryptedCredential

認証に使用される暗号化された資格情報。 資格情報は、統合ランタイム資格情報マネージャーを使用して暗号化されます。 型: string (または resultType 文字列を含む式)。

encryptedCredential?: any

プロパティ値

any

failoverPartner

プライマリ サーバーがダウンしている場合に接続するパートナー サーバーの名前またはアドレス。推奨バージョンで使用されます。 型: string (または resultType 文字列を含む式)。

failoverPartner?: any

プロパティ値

any

hostNameInCertificate

接続のサーバー証明書を検証するときに使用するホスト名。 指定しない場合、データ ソースのサーバー名は証明書の検証に使用され、推奨バージョンで使用されます。 型: string (または resultType 文字列を含む式)。

hostNameInCertificate?: any

プロパティ値

any

integratedSecurity

接続でユーザー ID とパスワードを指定するか (false の場合)、または現在の Windows アカウントの資格情報を認証に使用するか (true の場合)、推奨バージョンで使用するかを指定します。 型: Boolean (または resultType ブール値を持つ式)。

integratedSecurity?: any

プロパティ値

any

loadBalanceTimeout

推奨バージョンで使用される、破棄される前の接続プールに接続が存在する最小時間 (秒単位)。 型: 整数 (または resultType 整数を持つ式)。

loadBalanceTimeout?: any

プロパティ値

any

maxPoolSize

推奨バージョンで使用される、この特定の接続文字列に対して接続プールで許可される接続の最大数。 型: 整数 (または resultType 整数を持つ式)。

maxPoolSize?: any

プロパティ値

any

minPoolSize

推奨バージョンで使用される、この特定の接続文字列に対して接続プールで許可される接続の最小数。 型: 整数 (または resultType 整数を持つ式)。

minPoolSize?: any

プロパティ値

any

multipleActiveResultSets

true の場合、アプリケーションは複数のアクティブな結果セット (MARS) を維持できます。 false の場合、アプリケーションは、その接続で他のバッチを実行する前に、1 つのバッチからすべての結果セットを処理または取り消す必要があります。 型: Boolean (または resultType ブール値を持つ式)。

multipleActiveResultSets?: any

プロパティ値

any

multiSubnetFailover

アプリケーションが異なるサブネット上の AlwaysOn 可用性グループ (AG) に接続している場合、MultiSubnetFailover=true を設定すると、推奨バージョンで使用される (現在) アクティブなサーバーの検出と接続が高速化されます。 型: Boolean (または resultType ブール値を持つ式)。

multiSubnetFailover?: any

プロパティ値

any

packetSize

推奨バージョンで使用される、サーバーのインスタンスとの通信に使用されるネットワーク パケットのサイズ (バイト単位)。 型: 整数 (または resultType 整数を持つ式)。

packetSize?: any

プロパティ値

any

password

オンプレミスの Windows 認証パスワード。

password?: SecretBaseUnion

プロパティ値

SecretBaseUnion

pooling

推奨バージョンで使用される、接続が要求されるたびに接続をプールするか、明示的に開くかを指定します。 型: Boolean (または resultType ブール値を持つ式)。

pooling?: any

プロパティ値

any

server

推奨バージョンで使用される、接続先の SQL Server インスタンスの名前またはネットワーク アドレス。 型: string (または resultType 文字列を含む式)。

server?: any

プロパティ値

any

trustServerCertificate

推奨バージョンで使用される信頼を検証するために、証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。 型: Boolean (または resultType ブール値を持つ式)。

trustServerCertificate?: any

プロパティ値

any

type

ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

type: "SqlServer"

プロパティ値

"SqlServer"

userName

オンプレミスの Windows 認証ユーザー名。 型: string (または resultType 文字列を含む式)。

userName?: any

プロパティ値

any

継承されたプロパティの詳細

annotations

リンクされたサービスの説明に使用できるタグの一覧。

annotations?: any[]

プロパティ値

any[]

linkedService.annotations から継承

connectVia

統合ランタイムリファレンス。

connectVia?: IntegrationRuntimeReference

プロパティ値

IntegrationRuntimeReference

LinkedService.connectVia から継承

description

リンクされたサービスの説明。

description?: string

プロパティ値

string

linkedService.description から継承

parameters

リンクされたサービスのパラメーター。

parameters?: {[propertyName: string]: ParameterSpecification}

プロパティ値

{[propertyName: string]: ParameterSpecification}

LinkedService.parameters から継承

version

リンクされたサービスのバージョン。

version?: string

プロパティ値

string

linkedService.version から継承