ConfigMgrPolicyBodyDownloadRequest Class
Downloads a policy message from a management point.
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.SynchronousMessageRequest
Microsoft.ConfigurationManagement.Messaging.Framework.SynchronousMessageRequest<TSynchronousReply>
Microsoft.ConfigurationManagement.Messaging.Messages.GetMessageRequest<TGetReply>
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrPolicyBodyDownloadRequest
Syntax
[SerializableAttribute]
[MessageClassAttribute(MessageClassAttributeSetting.NotSigned)]
[SupportedSenderAttribute("Microsoft.ConfigurationManagement.Messaging.Sender.Http.HttpSender")]
[MessageSupportAttribute(MessageSupportStatus.Supported)]
public class ConfigMgrPolicyBodyDownloadRequest : GetMessageRequest<ConfigMgrPolicyBodyDownloadReply>
[SerializableAttribute]
[MessageClassAttribute(MessageClassAttributeSetting::NotSigned)]
[SupportedSenderAttribute("Microsoft.ConfigurationManagement.Messaging.Sender.Http.HttpSender")]
[MessageSupportAttribute(MessageSupportStatus::Supported)]
public ref class ConfigMgrPolicyBodyDownloadRequest : GetMessageRequest<ConfigMgrPolicyBodyDownloadReply^>
<SerializableAttribute>
<MessageClassAttribute(MessageClassAttributeSetting.NotSigned)>
<SupportedSenderAttribute("Microsoft.ConfigurationManagement.Messaging.Sender.Http.HttpSender")>
<MessageSupportAttribute(MessageSupportStatus.Supported)>
Public Class ConfigMgrPolicyBodyDownloadRequest
Inherits GetMessageRequest(Of ConfigMgrPolicyBodyDownloadReply)
Constructors
| Name | Description | |
|---|---|---|
.jpeg "System_CAPS_pubmethod") |
ConfigMgrPolicyBodyDownloadRequest() | Initializes a new instance of the ConfigMgrPolicyBodyDownloadRequest class. If you use this constructor, use AddPolicyLocation() to add download locations, or SendMessage will fail. |
|
ConfigMgrPolicyBodyDownloadRequest(ConfigMgrPolicyAssignmentReply) | Initializes a new instance of the ConfigMgrPolicyBodyDownloadRequest class. Takes an existing policy reply and extracts the locations from it. |
|
ConfigMgrPolicyBodyDownloadRequest(IMessage, PolicyAssignment) | Initializes a new instance of the ConfigMgrPolicyBodyDownloadRequest 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.) |
|
DownloadDcmCIs | When set to true, if there's a policy that points to a DCM configuration item, that configuration item will be downloaded. |
|
DownloadSecrets | If true, secrets will be downloaded in mixed mode. The default value is false. |
|
ForceSmsIdSignature | If true, SMSID signing will be used on the message sent to the management point. SMSID signing is not always needed and can cause a performance hit on the management point. The default value is false, which means a signature will only be added if it's required by the assignment. |
|
MessageId | Gets the internal ID of a message. (Inherited from Message.) |
.jpeg "System_CAPS_protproperty") |
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.) |
|
ReplyType | Gets the reply type encapsulated by the message. (Inherited from SynchronousMessageRequest.) |
|
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 to use for sending a message. Some messages require this property. (Inherited from Message.) |
|
SmsId | Gets or sets the SMSID for the policy request. (Overrides Message.SmsId.) |
|
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.) |
|
AddPolicyAssignment(PolicyAssignment) | Adds a policy assignment to the internal list. |
|
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, if supported by the message. (Inherited from Message.) |
|
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.) |
|
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. (Overrides GetMessageRequest<TGetReply>.PreSendActions().) |
|
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 and gets a reply with the policy message. (Overrides SynchronousMessageRequest<TSynchronousReply>.SendMessage(IMessageSender).) |
|
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() | Internal handler for serializing the message payload to its wire-level format. This method should only be called by external code under exceptional circumstances. (Inherited from Message.) |
|
SetCustomHeader(MessageSettings, SmsClientId, MessageCertificateX509) | Sets the custom header details for the policy body download request. |
|
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.) |
Remarks
This message is technically NotSigned because it doesn't sign the message header. It does, however, sign the SMSID in the HTTP header. You must still provide a signing certificate. Setting the SigningSmsID property has no effect on this message because it signs on the SmsId.
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
Microsoft.ConfigurationManagement.Messaging.Messages Namespace
Return to top