言語

MessageQueueTask クラス

定義

名前空間:
Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
アセンブリ:
Microsoft.SqlServer.MSMQTask.dll

メッセージキュータスクで使用されるメソッドとプロパティを含みます。 このクラスは継承できません。

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 IDTSSuspend
Public NotInheritable Class MessageQueueTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IMessageQueueTask
継承
Object
DtsObject
Task
MessageQueueTask
属性
DtsTaskAttribute
実装
IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IMessageQueueTask

注釈

メッセージキュータスククラスは、オブジェクトがメッセージキューイング(MSMQ)のキューとメッセージを送受信することを可能にします。 Microsoft 分散トランザクション コーディネーター(MSDTC)を実行中は分散トランザクションへの参加が許可されています。 メッセージキュータスクの単一インスタンスは、指定されたキューに1つのメッセージを送信するか、指定されたキューから1つのメッセージを受け取り、必要に応じてメッセージの到着を待ちます。 送信可能なメッセージの種類は以下の通りです:

  • 文字列メッセージで、プロパティの値として提供されます。

  • 指定されたデータファイルの内容から生成されるデータファイルメッセージ。

  • 変数メッセージで、1つ以上のSQL Server Integration Services変数の名前と値から生成されます。

列挙 MQMessageType は、特定のメッセージキュータスクで使用されるメッセージ形式を決定します。

詳細は「 メッセージキュータスク」を参照してください。

APIでもSSIS DesignerでもMessageQueueTaskを動かすには、SQL Server Integration Servicesをインストールする必要があります。 この機能はSQL Server Data Tools(SSDT)のみをインストールすると動作しません。

Important

メッセージキュータスクをメッセージ送信に設定する際、現在Message QueuingでサポートされているRC2およびRC4の暗号化アルゴリズムのいずれかを使ってメッセージを暗号化できます。 現在、いずれの暗号化アルゴリズムも、メッセージ キューでまだサポートされていない最新のアルゴリズムと比較して、暗号強度の弱さが指摘されています。 そのため、メッセージ キュー タスクを使ってメッセージを送信する場合は、必要な暗号強度を満たすことができるかどうかを十分に検討する必要があります。

コンストラクター

名前 説明
MessageQueueTask()

MessageQueueTask クラスの新しいインスタンスを初期化します。

プロパティ

名前 説明
CurrentExecutingPackageID

現在実行中のパッケージのIDを取得したり設定したりします。
DataFileOverWritable

データファイルメッセージが既存のデータファイルを上書きできるかどうかを示すブール値を取得または設定します。
DebugMode

オブジェクトがデバッグモードにあるかどうか、実行中に OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) イベントを発生させるべきかどうかを示すブール値を取得または設定します。
DTSMessageLineageID

メッセージの系譜識別子を取得するか設定します。
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

メッセージをキューから削除すべきかどうかを指定するブール値を取得または設定します。
SaveDataFileName

着信するデータファイルメッセージが保存されるファイル名を取得するか設定します。
StringCompareType

TaskTypeがDTSMQType_Receiverされたときの文字列メッセージタイプの文字列比較方法を指定する値を。
StringCompareValue

TaskTypeがDTSMQType_Receiverされたとき、文字列メッセージを比較するストリングを取得します。
StringMessageToVariableName

メッセージの内容が保存される変数の名前を取得するか設定します。
SuspendRequired

ブーリアンを取得したり設定したりし、ブレークポイントに到達した際にタスクを一時停止すべきかどうかを示します。 この値は、ブレークポイントが発生した際にランタイムエンジンがタスクやコンテナに対して設定します。
TargetServerVersion

メッセージキュータスクで使用されるメソッドとプロパティを含みます。 このクラスは継承できません。

(継承元 Task)
TaskType

メッセージタスクが送信中か受信中かを示す値を取得または設定します。
Use2000Format

メッセージがSQL Server 2000形式を使用していることを示すブール値を取得または設定します。
UseEncryption

メッセージが暗号化を使用しているかどうかを示すブール値を取得または設定します。
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形式(拡張子 the.xml)で保存されたパッケージを読み込むには、 LoadPackage(String, IDTSEvents) メソッドを使用します。
ResumeExecution()

一時停止した後、作業の実行を再開する。 タスクやコンテナの実行はランタイムエンジンによって再開されます。
SaveToXML(XmlDocument, IDTSInfoEvents)

このメソッドはアプリケーションコードでは呼び出せません。 パッケージを .xmlとして保存するには、 SaveToXml(String, Package, IDTSEvents) メソッドを使います。
SuspendExecution()

実行ファイルが一時停止する必要があることを示します。 このメソッドはランタイムエンジンによって呼び出されます。
Update(String)

メンバーは棄権しました;「注釈」を参照してください。 このメソッドは、 CanUpdate(String) がtrueに設定されている場合、古いパッケージXMLを新しいパッケージXMLに更新します。

(継承元 Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

タスクが正しく設定されているかを確認します。

適用対象