ConfigMgrStateMessage Class
Sends state messages to the management point. If you need to send a message to a fallback status point, use ConfigMgrFspStateMessage instead.
Namespace: Microsoft.ConfigurationManagement.Messaging.Messages
Assembly: Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)
Inheritance Hierarchy
System.Object
Microsoft.ConfigurationManagement.Messaging.Framework.Message
Microsoft.ConfigurationManagement.Messaging.Framework.AsynchronousMessage
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrInventoryMessage
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrRelayMessage
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrStateMessage
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrFspStateMessage
Syntax
[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus.Supported)]
[MessageClassAttribute(MessageClassAttributeSetting.None)]
public class ConfigMgrStateMessage : ConfigMgrRelayMessage
[SerializableAttribute]
[MessageSupportAttribute(MessageSupportStatus::Supported)]
[MessageClassAttribute(MessageClassAttributeSetting::None)]
public ref class ConfigMgrStateMessage : ConfigMgrRelayMessage
<SerializableAttribute>
<MessageSupportAttribute(MessageSupportStatus.Supported)>
<MessageClassAttribute(MessageClassAttributeSetting.None)>
Public Class ConfigMgrStateMessage
Inherits ConfigMgrRelayMessage
Constructors
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
ConfigMgrStateMessage() | Initializes a new instance of the ConfigMgrStateMessage class. |
Properties
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubproperty") |
Attachments | Gets message attachments. (Inherited from Message.) |
|
Body | Gets the message body. This property should not be empty, with limited exceptions.(Inherited from Message.) |
.jpeg "System_CAPS_protproperty") |
BodyAsAttachment | Indicates whether relay messages send the body as an attachment. (Inherited from ConfigMgrRelayMessage.) |
|
ClientVersion | Gets or sets the client version for the client sending the state message. If you don't set this property, a random version will be set. (Inherited from ConfigMgrInventoryMessage.) |
|
CodePage | Gets or sets the code page for the message. (Inherited from ConfigMgrInventoryMessage.) |
|
DiscoveredNetBiosName | Gets a value that indicates whether the NetBiosName property was derived from discovery. (Inherited from ConfigMgrInventoryMessage.) |
|
FileType | Gets the file type for state messages. (Overrides ConfigMgrRelayMessage.FileType.) |
|
FullStateMessage | Do not use. This property builds an entire state message from scratch. StateMessage uses defaults. |
|
IncludeMachinePublicKey | Gets or sets a value that indicates whether, when the BuildInventoryMessage method is used, a public key will be included in the inventory report. (Inherited from ConfigMgrInventoryMessage.) |
|
InventoryReport | Gets or sets the entire serialized inventory message. The BuildInventoryMessage method should be used to initialize the message; we don't recommend setting everything manually. (Inherited from ConfigMgrInventoryMessage.) |
|
LocaleId | Gets or sets the locale ID for state messages. The default value is the locale ID for the current process. (Inherited from ConfigMgrInventoryMessage.) |
|
MessageId | Gets the internal ID of a message. (Inherited from Message.) |
|
NetBiosName | Gets or sets the NetBIOS name of the computer that generates the state message. If you don't set this value, the name of the executing machine is used. (Inherited from ConfigMgrInventoryMessage.) |
|
PostSendActionsSupported | Gets a value that indicates whether the message supports post-send actions. (Inherited from Message.) |
|
Priority | Gets the priority for a message. This property is only used for reference by senders and has no effect on the message. (Inherited from Message.) |
|
ReportContentType | Gets the report content type for state messages. (Overrides ConfigMgrInventoryMessage.ReportContentType.) |
|
ReportFormat | Gets or sets the report format. The default report format is 1.1. This property can be overridden by inheriting classes. (Inherited from ConfigMgrInventoryMessage.) |
|
ReportVersion | Gets or sets the report version. The default report version is 1.0. This property can be overridden by inheriting classes (Inherited from ConfigMgrInventoryMessage.) |
|
RequireXmlHeader | If true, an XML header is required. If false, an XML header is not required (such as for a fallback status point). |
|
SenderCallback | Gets a sender callback for a message. This property is null unless a message is in the process of being sent. (Inherited from Message.) |
|
SenderType | Gets the sender type for a message. This property is only used for reference by senders and has no effect on the message. (Inherited from Message.) |
|
Settings | Gets message settings. (Inherited from Message.) |
|
SiteCode | Gets or sets the site code for the message. This property is optional. (Inherited from ConfigMgrInventoryMessage.) |
|
SmsId | Gets or sets the SMSID used for the message. This property must be set for inventory messages. (Inherited from ConfigMgrInventoryMessage.) |
|
StateMessages | Gets the state message to be sent to the management point. |
|
StateMessageType | Gets or sets the state message type. |
|
SupportsInlineSerializers | Gets a value that indicates whether Serialize() is called on send and DeserializeMessageBody is called on receive. The default setting for this property is true. Override to false with caution. (Inherited from Message.) |
Methods
| Name | Description | |
|---|---|---|
|
AddCertificateToMessage(MessageCertificateX509, CertificatePurposes) | Adds a certificate to the message. (Inherited from Message.) |
|
AddCertificateToMessage(MessageCertificateX509, CertificatePurposes, Boolean) | Adds a certificate to a message with the option to disable any intelligence. (Inherited from Message.) |
|
AddStateMessage(StateMessage) | Adds a state message to the internal store to send to the management point or fallback status point. |
|
BuildInventoryMessage(Collection<InventoryReportBodyElement>) | Constructs an inventory report from an InventoryReportBodyElement object array. (Inherited from ConfigMgrInventoryMessage.) |
|
BuildInventoryMessage(Collection<InventoryReportBodyElement>, Boolean) | Constructs an inventory report from an InventoryReportBodyElement object array. (Inherited from ConfigMgrInventoryMessage.) |
|
BuildInventoryMessage(InventoryReportBodyElement) | Constructs an inventory report from an InventoryReportBodyElement object by using default settings. (Inherited from ConfigMgrInventoryMessage.) |
|
BuildInventoryMessage(InventoryReportBodyElement, Boolean) | Constructs an inventory report from an InventoryReportBodyElement object by using default settings. (Inherited from ConfigMgrInventoryMessage.) |
|
CloneBase() | Creates a clone of a message. Important: This method is not the same as nor does it behave the same as Clone. That is why this message type does not implement ICloneable. It is not recommended that any code outside of Messaging core code use this function without understanding how it works, what its limitations are, and why it's being used. Note: If you're considering this method, ensure that you have evaluated CloneByRef which you might want to use instead. (Inherited from Message.) |
|
CloneByRef(IMessage) | Clones a reference of a message. Use this method to create a copy of an existing message, especially one of a different type, into this message. Important: This method is not the same as nor does it behave the same as Clone. That is why this message type does not implement ICloneable. It is not recommended that any code outside of Messaging core code use this function without understanding how it works, what its limitations are, and why it's being used. (Inherited from Message.) |
|
CloneByRef(IMessage, MessageCloneOptions) | Clones a reference of a message. Use this method to create a copy of an existing message, especially one of a different type, into this message. Important: This method is not the same as nor does it behave the same as Clone. That is why this message type does not implement ICloneable. It is not recommended that any code outside of Messaging core code use this function without understanding how it works, what its limitations are, and why it's being used. (Inherited from Message.) |
.jpeg "System_CAPS_protmethod") |
CriticalSection(Action) | Invokes a statement within a thread-safe critical section. (Inherited from Message.) |
|
CriticalSection<T>(Func<T>) | Invokes a statement within a thread-safe critical section. (Inherited from Message.) |
|
DeserializeMessageBody() | Internal handler for deserializing a payload into its object format. This method should only be called by external code under exceptional circumstances. (Inherited from Message.) |
|
Discover() | Performs discovery. (Inherited from ConfigMgrInventoryMessage.) |
|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Object.) |
|
GetCertificateFromMessage(CertificatePurposes) | Retrieves the X509-based certificate from a message. (Inherited from Message.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
InstancesContainsElementOfType(IList<InventoryReportBodyElement>, Tuple<Type, Boolean>[]) | Verifies whether a particular type of instance is contained in a collection of elements. (Inherited from ConfigMgrInventoryMessage.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
OnDeserialization(Object) | Ensures validity checks are never performed on deserialization. (Inherited from Message.) |
|
PostSendActions(IMessageSender, Boolean) | Actions that run after a message is sent. This is an asynchronous action; use with caution. (Inherited from Message.) |
|
PreSendActions() | Performs pre-send actions. (Inherited from ConfigMgrRelayMessage.) |
|
SendInlineStatusMessage(SmsEvent, IMessageSender) | Sends a status message. This is a synchronous operation and should be called from a separate thread to avoid blocking. (Inherited from Message.) |
|
SendInlineStatusMessage(StatusMessage, IMessageSender) | Sends a status message. This is a synchronous operation and should be called from a separate thread to avoid blocking. (Inherited from Message.) |
|
SendMessage(IMessageSender) | Sends the message using the specified sender.(Inherited from AsynchronousMessage.) |
|
SendMessageAsync(IMessageSender) | Sends a message by using the specified sender. (Inherited from Message.) |
|
SendMessageSync<T>(IMessageSender) | Sends a message by using the specified sender. (Inherited from Message.) |
|
SerializeMessageBody() | Serializes the payload. (Overrides ConfigMgrInventoryMessage.SerializeMessageBody().) |
|
SimpleBodyDeserialization<T>() | Helper function that deserializes an object from the existing payload. (Inherited from Message.) |
|
SimpleBodyDeserialization<T>(DeserializationArguments) | Helper function that deserializes an object from the existing payload. (Inherited from Message.) |
|
SimpleObjectSerialization(Object) | Helper function that serializes an object to a payload. (Inherited from Message.) |
|
ToString() | (Inherited from Object.) |
|
Validate() | Obsolete. Validates that all required message settings are present and meet the requirements. If this method fails, the message will likely fail in being sent or processed by the site or management point. (Inherited from Message.) |
|
Validate(IMessageSender) | Validates that all required message settings are present and meet the requirements. If this validation fails, the message is almost certain to fail in being sent or processed by the site or management point. (Inherited from Message.) |
Fields
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_protfield") |
Synchronizer | Synchronizer to use for locking in thread-safe operations. (Inherited from Message.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubinterface") .jpeg "System_CAPS_privmethod") |
IMessage.SendMessage(IMessageSender) | Sends a message by using the specified sender. (Inherited from Message.) |
.jpeg "System_CAPS_privproperty") |
IMessageBase.Settings | Gets message properties and settings. (Inherited from Message.) |
Examples
// Create new sender instance
HttpSender sender = new HttpSender();
ConfigMgrStateMessage message = new ConfigMgrStateMessage();
// Add signing certificate to the message
message.AddCertificateToMessage(new MessageCertificateX509Volatile("MyCertificate.pfx", "password"), CertificatePurposes.Signing);
message.Settings.HostName = "MyManagementPoint";
// Create a state message object and add it the message
StateMessage stateMessage = new StateMessage();
stateMessage.State.Id = StateMessageStateId.ClientFrameworkModeReadinessReady;
stateMessage.State.Criticality = 0;
stateMessage.Topic.Id = "CCM Framework Mode Readiness";
stateMessage.Topic.IdType = StateMessageTopicIdType.FrameworkState;
stateMessage.StateDetails = new StateDetails();
stateMessage.StateDetails.StateDetailsContents = new StateDetailsContentsClientIdentity(true);
stateMessage.UserParameters.AddStateMessageParameter(0);
stateMessage.UserParameters.AddStateMessageParameter(Environment.MachineName);
message.AddStateMessage(stateMessage);
// Send the message to the management point
message.SendMessage(sender);
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
ConfigMgrFspStateMessage
Microsoft.ConfigurationManagement.Messaging.Messages Namespace
Return to top