MessageQueueTask Classe

Définition

Espace de noms:

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask

Assembly:

Microsoft.SqlServer.MSMQTask.dll

Contient les méthodes et les propriétés utilisées par la tâche MSMQ. Cette classe ne peut pas être héritée.

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 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 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

Héritage

Object

DtsObject

Task

MessageQueueTask

Attributs

DtsTaskAttribute

Implémente

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IMessageQueueTask

Remarques

La classe de tâche Message Queue permet à un objet d’envoyer et de recevoir des messages vers ou à partir d’une file d’attente de Message Queuing (également appelé MSMQ). La participation aux transactions distribuées est autorisée lors de l’exécution de Microsoft Distributed Transaction Coordinator (MSDTC). Une seule instance d’une tâche file d’attente de messages envoie un message à une file d’attente spécifiée ou reçoit un seul message d’une file d’attente spécifiée, et attend, si nécessaire, que le message arrive. Les types de messages suivants peuvent être envoyés :

• Message de chaîne, qui est fourni comme valeur d’une propriété.

• Message de fichier de données, généré à partir du contenu d’un fichier de données spécifié.

• Message de variables, généré à partir des noms et des valeurs d’une ou plusieurs variables Integration Services SQL Server.

L’énumération MQMessageType détermine le format de message utilisé par une tâche de file d’attente de messages spécifique.

Pour plus d’informations, consultez la tâche file d’attente des messages.

Pour que le MessageQueueTask travail fonctionne dans l’API ou dans le Concepteur SSIS, vous devez installer SQL Server Integration Services. Cette fonctionnalité ne fonctionnera pas si seule SQL Server Data Tools (SSDT) est installée.

Important

Lors de la configuration de la tâche File d’attente de messages pour envoyer des messages, vous pouvez utiliser l’un des algorithmes de chiffrement actuellement pris en charge par message Queuing, RC2 et RC4 pour chiffrer le message. Ces deux algorithmes de chiffrement sont aujourd'hui considérés comme faibles du point de vue du chiffrement par rapport aux algorithmes plus récents, non encore pris en charge par la technologie Microsoft Message Queuing. Par conséquent, vous devez minutieusement évaluer vos besoins en matière de chiffrement si vous souhaitez envoyer des messages à l'aide de la tâche MSMQ.

Constructeurs

MessageQueueTask()

Initialise une nouvelle instance de la classe MessageQueueTask.

Propriétés

CurrentExecutingPackageID	Obtient ou définit l'ID du package actuellement en cours d'exécution.
DataFileOverWritable	Obtient ou définit une valeur booléenne qui indique si le message de fichier de données peut remplacer un fichier de données existant.
DebugMode	Obtient ou définit une valeur booléenne qui indique si l’objet est en mode débogage et s’il doit déclencher l’événement lors de l’exécution OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) .
DTSMessageLineageID	Obtient ou définit l'identificateur de lignage du message.
DTSMessagePackageID	Obtient ou définit l'identificateur du package qui est la source du message.
DTSMessageVersionID	Obtient ou définit la version du message.
EncryptionAlgo	Obtient ou définit le nom de l'algorithme de chiffrement utilisé pour chiffrer le corps d'un message privé.
ErrorIfMessageTimeOut	Obtient ou définit une valeur booléenne spécifiant si la tâche échoue lorsque le message expire.
ExecutionValue	Retourne un objet défini par l'utilisateur. Ce champ est en lecture seule. (Hérité de Task)
MessageDataFile	Obtient ou définit le nom du fichier de données utilisé lorsque la propriété MessageType est définie sur DTSMQMessageType_DataFile.
MessageString	Obtient ou définit le message à utiliser lorsque la propriété MessageType est définie sur DTSMQMessageType_String.
MessageType	Obtient ou définit une valeur qui indique le type de message envoyé lorsque la propriété TaskType est DTSMQType_Sender.
MessageVariables	Obtient ou définit la liste des variables lorsque l'énumération MQMessageType est définie sur DTSMQMessageType_Variables.
MsmqConnection	Obtient ou définit le nom de la connexion pour la tâche MSMQ.
OperationDescription	Obtient ou définit la description de l'opération.
ReceiveMessageTimeOut	Obtient ou définit une valeur qui spécifie le nombre de secondes avant qu'un message reçu expire.
ReceiveMessageType	Obtient ou définit une valeur MQMessageType qui indique le type de message à recevoir.
ReceiveVariableMessage	Obtient ou définit le nom de la variable dans laquelle stocker le message.
RemoveFromQueue	Obtient ou définit une valeur booléenne qui spécifie si le message doit être supprimé de la file d’attente.
SaveDataFileName	Obtient ou définit le nom du fichier sous lequel un message de fichier de données entrant est enregistré.
StringCompareType	Valeur qui spécifie la méthode de comparaison de chaînes pour un type de message String lorsque l’objet TaskType est DTSMQType_Receiver.
StringCompareValue	Obtient ou définit la chaîne à laquelle un message de chaîne est comparé au moment où l’objet TaskType est DTSMQType_Receiver.
StringMessageToVariableName	Obtient ou définit le nom de la variable dans laquelle le contenu du message est enregistré.
SuspendRequired	Obtient ou définit une valeur booléenne qui indique si la tâche doit s’interrompre lorsqu’elle rencontre un point d’arrêt. Cette valeur est définie par le moteur du runtime pour les tâches et les conteneurs lorsqu'un point d'arrêt est rencontré.
TargetServerVersion	Contient les méthodes et les propriétés utilisées par la tâche MSMQ. Cette classe ne peut pas être héritée. (Hérité de Task)
TaskType	Obtient ou définit une valeur qui indique si la tâche de messages envoie ou reçoit.
Use2000Format	Obtient ou définit une valeur booléenne indiquant que le message utilise SQL Server format 2000.
UseEncryption	Obtient ou définit une valeur booléenne indiquant si le message utilise le chiffrement.
Version	*** Membre déconseillé ; consultez les Remarques. *** Retourne la version de la tâche. Cette propriété est en lecture seule. (Hérité de Task)

Méthodes

AcceptBreakpointManager(BreakpointManager)	Transmet un objet BreakpointManager à une tâche. Cette méthode est appelée par le runtime et n'est pas utilisée dans le code.
CanUpdate(String)	*** Membre déconseillé ; consultez les Remarques. Valeur booléenne qui indique si le nouveau package XML peut mettre à jour l’ancien xml de package. (Hérité de Task)
Equals(Object)	Détermine si les deux instances d'objet sont égales. (Hérité de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Exécute la tâche.
GetConnectionID(Connections, String)	Obtient une chaîne contenant l’ID de la connexion. (Hérité de Task)
GetConnectionName(Connections, String)	Obtient une chaîne contenant le nom de la connexion. (Hérité de Task)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Initialise les propriétés associées à la tâche. Cette méthode est appelée par le runtime et n'est pas utilisée dans le code.
LoadFromXML(XmlElement, IDTSInfoEvents)	Cette méthode ne peut pas être appelée par votre code d'application. Pour charger un package enregistré au format XML (avec l'extension de nom de fichier .xml), utilisez la méthode LoadPackage(String, IDTSEvents).
ResumeExecution()	Reprend l'exécution de la tâche après une suspension. L'exécution de la tâche ou du conteneur est reprise par le moteur du runtime.
SaveToXML(XmlDocument, IDTSInfoEvents)	Cette méthode ne peut pas être appelée par votre code d'application. Pour enregistrer un package en tant que .xml, utilisez la méthode SaveToXml(String, Package, IDTSEvents).
SuspendExecution()	Indique que l'exécutable doit s'interrompre. Cette méthode est appelée par le moteur du runtime.
Update(String)	*** Membre déconseillé ; consultez les Remarques. Cette méthode met à jour l’ancien xml de package avec le nouveau xml de package s’il CanUpdate(String) est défini sur true. (Hérité de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Vérifie que la tâche est configurée correctement.