MessageQueueTask クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
メッセージ キュー タスクで使用されるメソッドとプロパティを含みます。 このクラスは継承できません。
public ref class MessageQueueTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::MessageQueueTask::IMessageQueueTask[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
inherit Task
interface IDTSComponentPersist
interface IMessageQueueTask
interface IDTSBreakpointSite
interface IDTSSuspend[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
inherit Task
interface IDTSComponentPersist
interface IMessageQueueTask
interface IDTSBreakpointSite
interface IDTSSuspend[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
inherit Task
interface IDTSComponentPersist
interface IMessageQueueTask
interface IDTSBreakpointSite
interface IDTSSuspendPublic NotInheritable Class MessageQueueTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IMessageQueueTask- 継承
- 属性
- 実装
注釈
メッセージ キュー タスク クラスを使用すると、オブジェクトは、メッセージ キュー (MSMQ) のキューとの間でメッセージを送受信できます。 Microsoft 分散トランザクション コーディネーター (MSDTC) を実行している場合は、分散トランザクションへの参加が可能です。 メッセージ キュー タスクの単一のインスタンスは、指定したキューに 1 つのメッセージを送信するか、指定したキューから単一のメッセージを受信し、必要に応じてメッセージの到着を待機します。 次の種類のメッセージを送信できます。
プロパティの値として提供される文字列メッセージです。
指定したデータ ファイルの内容から生成されたデータ ファイル メッセージです。
1 つ以上の SQL Server Integration Services 変数の名前と値から生成される変数メッセージ。
MQMessageType 列挙によって、特定のメッセージ キュー タスクで使用されるメッセージ形式が決まります。
詳細については、「 メッセージ キュー タスク」を参照してください。
MessageQueueTask を API または SSIS デザイナーで使用するためには、SQL Server Integration Services をインストールする必要があります。 SQL Server Data Tools (SSDT) のみがインストールされている場合、この機能は機能しません。
重要
メッセージ キュー タスクを構成してメッセージを送信する場合、メッセージ キューで現在サポートされている暗号化アルゴリズム (RC2 および RC4) のいずれかを使用してメッセージを暗号化できます。 現在、いずれの暗号化アルゴリズムも、メッセージ キューでまだサポートされていない最新のアルゴリズムと比較して、暗号強度の弱さが指摘されています。 そのため、メッセージ キュー タスクを使ってメッセージを送信する場合は、必要な暗号強度を満たすことができるかどうかを十分に検討する必要があります。
コンストラクター
| MessageQueueTask() |
MessageQueueTask クラスの新しいインスタンスを初期化します。 |
プロパティ
| CurrentExecutingPackageID |
現在実行中のパッケージの ID を取得します。値の設定も可能です。 |
| DataFileOverWritable |
データ ファイル メッセージが既存のデータ ファイルを上書きできるかどうかを示すブール型 (Boolean) の値を取得または設定します。 |
| DebugMode |
オブジェクトがデバッグ モードかどうか、および実行中にイベントを発生させる必要があるかどうかを示すブール型 (Boolean) の値を OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) 取得または設定します。 |
| DTSMessageLineageID |
メッセージ系列 ID を取得します。値の設定も可能です。 |
| DTSMessagePackageID |
メッセージのソースであるパッケージの識別子を取得します。値の設定も可能です。 |
| DTSMessageVersionID |
メッセージのバージョンを取得します。値の設定も可能です。 |
| EncryptionAlgo |
プライベート メッセージのメッセージ本文を暗号化するために使用される暗号化アルゴリズムの名前を取得します。値の設定も可能です。 |
| ErrorIfMessageTimeOut |
メッセージがタイムアウトしたときにタスクが失敗するかどうかを指定するブール値を取得または設定します。 |
| ExecutionValue |
ユーザー定義のオブジェクトを返します。 このフィールドは読み取り専用です。 (継承元 Task) |
| MessageDataFile |
MessageType が DTSMQMessageType_DataFile に設定されている場合に使用されるデータ ファイル名を取得します。値の設定も可能です。 |
| MessageString |
MessageType が DTSMQMessageType_String に設定されている場合に使用されるメッセージを取得します。値の設定も可能です。 |
| MessageType |
TaskType が DTSMQType_Sender である場合に送信されているメッセージの種類を示す値を取得します。値の設定も可能です。 |
| MessageVariables |
MQMessageType 列挙が DTSMQMessageType_Variables に設定されている場合の変数一覧を取得します。値の設定も可能です。 |
| MsmqConnection |
MSMQ タスクが使用する接続の名前を取得します。値の設定も可能です。 |
| OperationDescription |
操作の説明を取得します。値の設定も可能です。 |
| ReceiveMessageTimeOut |
受信メッセージがタイムアウトするまでの秒数を示す値を取得します。値の設定も可能です。 |
| ReceiveMessageType |
受信するメッセージの種類を示す MQMessageType 値を取得します。値の設定も可能です。 |
| ReceiveVariableMessage |
メッセージを格納する変数の名前を取得します。値の設定も可能です。 |
| RemoveFromQueue |
メッセージをキューから削除するかどうかを指定するブール型 (Boolean) の値を取得または設定します。 |
| SaveDataFileName |
着信データ ファイル メッセージが保存されるファイルの名前を取得します。値の設定も可能です。 |
| StringCompareType |
次の場合に、文字列メッセージ型の文字列比較メソッドを指定するTaskType値。DTSMQType_Receiver |
| StringCompareValue |
文字列メッセージの比較TaskTypeDTSMQType_Receiver対象となる文字列を取得または設定します。 |
| StringMessageToVariableName |
メッセージの内容が保存される変数の名前を取得します。値の設定も可能です。 |
| SuspendRequired |
ブレークポイントが発生したときにタスクを中断するかどうかを示すブール型 (Boolean) の値を取得または設定します。 この値は、ブレークポイントに到達したときにタスクおよびコンテナーに対してランタイム エンジンで設定されます。 |
| TargetServerVersion |
メッセージ キュー タスクで使用されるメソッドとプロパティを含みます。 このクラスは継承できません。 (継承元 Task) |
| TaskType |
メッセージ タスクが送信と受信のどちらを実行しているかを示す値を取得します。値の設定も可能です。 |
| Use2000Format |
メッセージが 2000 形式SQL Server使用されることを示すブール型 (Boolean) の値を取得または設定します。 |
| UseEncryption |
メッセージが暗号化を使用するかどうかを示すブール型 (Boolean) の値を取得または設定します。 |
| Version |
*** このメンバーは非推奨です。「解説」を参照してください。 タスクのバージョンを返します。 このプロパティは読み取り専用です。 (継承元 Task) |
メソッド
| AcceptBreakpointManager(BreakpointManager) |
タスクに BreakpointManager を渡します。 このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。 |
| CanUpdate(String) |
*** このメンバーは非推奨です。「解説」を参照してください。 新しいパッケージ XML が古いパッケージ XML を更新できるかどうかを示すブール値。 (継承元 Task) |
| Equals(Object) |
2 つのオブジェクト インスタンスが等しいかどうかを判断します。 (継承元 DtsObject) |
| Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) |
タスクを実行します。 |
| GetConnectionID(Connections, String) |
接続の ID を含む文字列を取得します。 (継承元 Task) |
| GetConnectionName(Connections, String) |
接続の名前を含む文字列を取得します。 (継承元 Task) |
| GetHashCode() |
このインスタンスのハッシュ コードを返します。 (継承元 DtsObject) |
| InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) |
タスクに関連付けられたプロパティを初期化します。 このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。 |
| LoadFromXML(XmlElement, IDTSInfoEvents) |
このメソッドをアプリケーション コードから呼び出すことはできません。 XML 形式 (ファイル名拡張子 .xml) で保存されたパッケージを読み込むには、LoadPackage(String, IDTSEvents) メソッドを使用します。 |
| ResumeExecution() |
一時停止したタスクの実行を再開します。 タスクまたはコンテナーの実行は、ランタイム エンジンによって再開されます。 |
| SaveToXML(XmlDocument, IDTSInfoEvents) |
このメソッドをアプリケーション コードから呼び出すことはできません。 パッケージを .xml として保存するには、SaveToXml(String, Package, IDTSEvents) メソッドを使用します。 |
| SuspendExecution() |
実行可能ファイルを中断する必要があることを示します。 このメソッドはランタイム エンジンから呼び出されます。 |
| Update(String) |
*** このメンバーは非推奨です。「解説」を参照してください。 このメソッドは、true に設定されている場合 CanUpdate(String) 、新しいパッケージ XML で古いパッケージ XML を更新します。 (継承元 Task) |
| Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) |
タスクが正しく構成されていることを確認します。 |