[This topic is pre-release documentation and
is subject to change in future releases. Blank topics are included
as placeholders.]
Assembly: Microsoft.ConfigurationManagement.Messaging(in Microsoft.ConfigurationManagement.Messaging.dll)
Downloads a policy message from an MP
Namespace:
Microsoft.ConfigurationManagement.Messaging.Messages
Assembly: Microsoft.ConfigurationManagement.Messaging(in Microsoft.ConfigurationManagement.Messaging.dll)
Syntax
C# | Visual Basic | Visual C++ |
[ 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 Class ConfigMgrPolicyBodyDownloadRequest _ Inherits GetMessageRequest( Of ConfigMgrPolicyBodyDownloadReply)
[ SerializableAttribute] [ MessageClassAttribute( MessageClassAttributeSetting::NotSigned)] [ SupportedSenderAttribute(L"Microsoft.ConfigurationManagement.Messaging.Sender.Http.HttpSender")] [ MessageSupportAttribute( MessageSupportStatus::Supported)] public ref class ConfigMgrPolicyBodyDownloadRequest : public GetMessageRequest< ConfigMgrPolicyBodyDownloadReply^>
Members
All Members | Constructors | Fields | Properties | Methods | Explicit Interface Implementations |
Public
Protected
|
Instance
Static
|
Declared
Inherited
|
XNA Framework Only
.NET Compact Framework
Only
|
|
Member | Description | |
---|---|---|
ConfigMgrPolicyBodyDownloadRequest () () () () |
Initializes a new instance of the
ConfigMgrPolicyBodyDownloadRequestclass. If this is used,
AddPolicyLocation() must be used to add download locations
otherwise SendMessage will fail
|
|
ConfigMgrPolicyBodyDownloadRequest(ConfigMgrPolicyAssignmentReply) |
Initializes a new instance of the
ConfigMgrPolicyBodyDownloadRequestclass. Takes an existing
policy reply and extracts the locations from it.
|
|
ConfigMgrPolicyBodyDownloadRequest(IMessage, PolicyAssignment) |
Initializes a new instance of the
ConfigMgrPolicyBodyDownloadRequestclass.
|
|
AddCertificateToMessage(MessageCertificateX509, CertificatePurposes) |
Adds a certificate to the
message (Inherited from
Message.) |
|
AddCertificateToMessage(MessageCertificateX509, CertificatePurposes, Boolean) |
Adds certificate to message with the option to
disable any intelligence (Inherited from
Message.) |
|
AddPolicyAssignment(PolicyAssignment) |
Adds a policy assignment to the internal
list
|
|
Attachments |
Gets Attachments to the
message. (Inherited from
Message.) |
|
Body |
Get/Set message body. This should never be
empty except for some very special cases. (Inherited from
Message.) |
|
CloneBase () () () () |
Creates a clone of this message
IMPORTANT: This is not the same as
Clone
()
()
()
()
which is why this message type does not implement
ICloneable. This does not behave the same as
Clone
()
()
()
()
. 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. Chances
are if you're looking at this method, you probably want to use
CloneByRef(IMessage)instead. (Inherited from
Message.) |
|
CloneByRef(IMessage) |
Clones a reference of a message. Use this for
doing a copy of an existing message (especially of a different
type) into this one.
IMPORTANT: This is not the same as
Clone
()
()
()
()
which is why this message type does not implement
ICloneable. This does not behave the same as
Clone
()
()
()
()
. 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 for
doing a copy of an existing message (especially of a different
type) into this one.
IMPORTANT: This is not the same as
Clone
()
()
()
()
which is why this message type does not implement
ICloneable. This does not behave the same as
Clone
()
()
()
()
. 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.) |
|
CriticalSection(Action) |
Invokes a statement within a thread-safe
critical section (Inherited from
Message.) |
|
CriticalSection < (Of < <' ( T > ) > > ) (Func < (Of < ( <' TResult > ) > ) > ) | (Inherited from Message.) | |
DeserializeMessageBody () () () () |
Internal handler for deserializing payload to
its object format. This should only be called by external code
under exceptional circumstances. (Inherited from
Message.) |
|
Discover () () () () |
Performs discovery if supported by the
message. (Inherited from
Message.) |
|
DownloadDcmCIs |
If true, if there's a policy that points to a
DCM CI, that CI will be downloaded
|
|
DownloadSecrets |
If true, secrets will be downloaded in mixed
mode. Defaults to false.
|
|
Equals(Object) | (Inherited from Object.) | |
Finalize () () () () | (Inherited from Object.) | |
ForceSmsIdSignature |
If true, SMSID signing will be used on the
message to the MP. SMSID signing is not always needed and can cause
a performance hit on the MP. Default is false which means a
signature will only be added if it's required by the
assignment.
|
|
GetCertificateFromMessage(CertificatePurposes) |
Retrieves X509-based certificate from
message. (Inherited from
Message.) |
|
GetHashCode () () () () | (Inherited from Object.) | |
GetType () () () () | (Inherited from Object.) | |
MemberwiseClone () () () () | (Inherited from Object.) | |
MessageId |
Internal ID of the message. (Inherited
from
Message.) |
|
OnDeserialization(Object) |
On deserialization, this ensures validity
checks are never performed. (Inherited from
Message.) |
|
PostSendActions(IMessageSender, Boolean) |
Actions to run after the message is sent
(asynchronous, use with care). (Inherited from
Message.) |
|
PostSendActionsSupported |
If true, message supports post-send
actions (Inherited from
Message.) |
|
PreSendActions () () () () |
Pre-send actions (Overrides
GetMessageRequest
<
(Of
<
(
<'
TGetReply
>
)
>
)
>
.
.
::
.
.
PreSendActions
()
()
()
()
.) |
|
Priority |
The priority for the message. This is only
used for reference by senders and has no actual effect on the
message (Inherited from
Message.) |
|
ReplyType |
Reply type encapsulated by this
message (Inherited from
SynchronousMessageRequest.) |
|
SenderCallback |
Callback to Sender for the message. This is
null unless a message is in the process of being
sent. (Inherited from
Message.) |
|
SenderType |
The sender type for the message. This is only
used for reference by senders and has no actual effect on the
message. (Inherited from
Message.) |
|
SendInlineStatusMessage(SmsEvent, IMessageSender) |
Sends a status message. This is a synchronous
operation so it 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 so it should be called from a separate thread to avoid
blocking (Inherited from
Message.) |
|
IMessage . . :: . . SendMessage(IMessageSender) |
Sends message via the specified
sender. (Inherited from
Message.) |
|
SendMessage(IMessageSender) |
Sends the message and gets a reply with the
policy message (Overrides
SynchronousMessageRequest
<
(Of
<
(
<'
TSynchronousReply
>
)
>
)
>
.
.
::
.
.
SendMessage(IMessageSender).) |
|
SendMessageAsync(IMessageSender) |
Sends message via the specified
sender. (Inherited from
Message.) |
|
SendMessageSync < (Of < <' ( T > ) > > ) (IMessageSender) |
Sends message via the specified
sender. (Inherited from
Message.) |
|
SerializeMessageBody () () () () |
Internal handler for serializing the message
payload to its wire-level format. This 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
|
|
IMessageBase . . :: . . Settings |
Message settings and
properties (Inherited from
Message.) |
|
Settings |
Message settings (Inherited from
Message.) |
|
SimpleBodyDeserialization < (Of < <' ( T > ) > > ) () () () () |
Helper function that deserializes the object
from the existing payload (Inherited from
Message.) |
|
SimpleBodyDeserialization < (Of < <' ( T > ) > > ) (DeserializationArguments) |
Helper function that deserializes the object
from the existing payload (Inherited from
Message.) |
|
SimpleObjectSerialization(Object) |
Helper function that serializes the object to
a payload (Inherited from
Message.) |
|
SiteCode |
Gets/sets the site code to use for sending the
message. Some messages require this. (Inherited from
Message.) |
|
SmsId |
SMSID for the policy request (Overrides
Message
.
.
::
.
.
SmsId.) |
|
SupportsInlineSerializers |
If true, Serialize() will be called on send,
and Deserialize() will be called on receive.
Default setting is true. Override to false with
care. (Inherited from
Message.) |
|
Synchronizer |
Synchronizer to use for locking in thread-safe
operations (Inherited from
Message.) |
|
ToString () () () () | (Inherited from Object.) | |
Validate () () () () |
Validates all required message settings are
present and meet the requirements. If this fails, it means that the
message is almost certain to fail sending or being processed by the
site/MP. (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 still must provide a signing certificate. Setting the
SigningSmsID has no effect on this message; it signs on the
SmsId.
Inheritance Hierarchy
System
.
.
::
.
.
Object
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . Message
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest < (Of < ( <' ConfigMgrPolicyBodyDownloadReply > ) > ) >
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . GetMessageRequest < (Of < ( <' ConfigMgrPolicyBodyDownloadReply > ) > ) >
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . ConfigMgrPolicyBodyDownloadRequest
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . Message
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest < (Of < ( <' ConfigMgrPolicyBodyDownloadReply > ) > ) >
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . GetMessageRequest < (Of < ( <' ConfigMgrPolicyBodyDownloadReply > ) > ) >
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . ConfigMgrPolicyBodyDownloadRequest