[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)
Base class used for creating SCCM client
registration requests
Registration is different in ConfigMgr 2007 versus ConfigMgr
2012, use the libary appropriate for this request.
Namespace:
Microsoft.ConfigurationManagement.Messaging.Messages
Assembly: Microsoft.ConfigurationManagement.Messaging(in Microsoft.ConfigurationManagement.Messaging.dll)
Syntax
C# | Visual Basic | Visual C++ |
[ SerializableAttribute] [ MessageSupportAttribute( MessageSupportStatus.Supported)] [ MessageClassAttribute( MessageClassAttributeSetting.NotSigned)] public abstract class ConfigMgrRegistrationRequestBase : SynchronousMessageRequest< ConfigMgrRegistrationReply>
< SerializableAttribute> _ < MessageSupportAttribute( MessageSupportStatus.Supported)> _ < MessageClassAttribute( MessageClassAttributeSetting.NotSigned)> _ Public MustInherit Class ConfigMgrRegistrationRequestBase _ Inherits SynchronousMessageRequest( Of ConfigMgrRegistrationReply)
[ SerializableAttribute] [ MessageSupportAttribute( MessageSupportStatus::Supported)] [ MessageClassAttribute( MessageClassAttributeSetting::NotSigned)] public ref class ConfigMgrRegistrationRequestBase abstract : public SynchronousMessageRequest< ConfigMgrRegistrationReply^>
Members
All Members |
Fields
![]() |
Properties
![]() |
Methods
![]() |
Explicit Interface Implementations
![]() |
![]() ![]() |
![]() ![]() ![]() |
![]() ![]() |
![]() ![]() ![]() ![]() |
|
Member | Description | |
---|---|---|
![]() |
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.) |
![]() |
AddRegistrationHint |
If true, a registration hint will be added to
the message before sending.
|
![]() |
AgentIdentity |
Get/Set agent identity. Usually somthing like
"MyClient.exe"
|
![]() |
AgentType |
Get/Set the agent type. Current valid agent
types are 0=AdvancedClient, 1=OsdCD, 2=Device, 4=IsvProxy,
8=IsvProxyClient
|
![]() |
AgentVersion |
Get/Set the agent version. Defaults to
null
|
![]() |
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.) |
![]() |
ClientFqdn |
The client FQDN of the registeing machine. If
unset, this will use the NetBiosName value.
|
![]() |
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.) |
![]() |
CreateConfirmationRequest () () () () |
Creates confirmation request
|
![]() |
CreateConfirmationRequestCallback(ClientRegistrationRequestData) |
Callback for changes for registration request
creation before signing occurs
|
![]() |
CreateRegistrationHint () () () () |
Creates a registration hint using the signing
certificate assigned to the registration request and assigns the
public property (RegistrationHint) with the generated hint. This
method requires one of the following to be set: SmsId (checked
first), SigningSmsId (checked second), RequestedSmsId (checked
last)
|
![]() |
CreateRegistrationHint(SmsClientId) |
Creates a registration hint using the signing
certificate assigned to the registration request and assigns the
public property (RegistrationHint) with the generated hint
|
![]() |
CreateRegistrationRequest () () () () |
Creates registration request
|
![]() |
CreateRegistrationRequestCallback(ClientRegistrationRequestData) |
Callback for special changes for registration
request creation before signing occurs
|
![]() |
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 (Overrides
Message
.
.
::
.
.
Discover
()
()
()
()
.) |
![]() |
DiscoveryProperties |
Get/Set the discovery properties. This is not
used in confirmation requests.
|
![]() |
EncryptionCertificate |
The encryption certificate used to include in
the registration request
|
![]() |
Equals(Object) | (Inherited from Object.) |
![]() |
Finalize () () () () | (Inherited from Object.) |
![]() |
GetCertificateFromMessage(CertificatePurposes) |
Retrieves X509-based certificate from
message. (Inherited from
Message.) |
![]() |
GetHashCode () () () () | (Inherited from Object.) |
![]() |
GetType () () () () | (Inherited from Object.) |
![]() |
HardwareId |
The Hardware ID of the registering machine.
Hardware ID's are used to identify the machine hardware and are
calculated using an implemention similar to Office's activiation
engine. Any string provided will suffice as a hardware id, as long
as it's unique to a machine.
|
![]() |
InternetStatus |
Client's Internet status. Defaults to None
(0)
|
![]() |
LocaleId |
The locale ID of the registering machine.
Defaults to the locale ID of the calling machine.
|
![]() |
MemberwiseClone () () () () | (Inherited from Object.) |
![]() |
MessageId |
Internal ID of the message. (Inherited
from
Message.) |
![]() |
NetBiosName |
The NetBIOS name of the registering machine.
This is a required property.
|
![]() |
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 () () () () |
Actions to run before the message is sent
(synchronous and blocking) (Inherited from
Message.) |
![]() |
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.) |
![]() |
RegisterClient(IMessageSender, TimeSpan) |
Helper method to perform a registration loop
for a new client
|
![]() ![]() |
RegisterClient(ConfigMgrRegistrationRequestBase, IMessageSender, TimeSpan) |
Helper method to perform a registration loop
for a new client
|
![]() |
RegistrationHint |
Gets or sets the registration hint to use for
registering with the site server.
|
![]() |
RegistrationRequest |
Registration request object
|
![]() |
RegistrationType |
Get or set the type of registration message to
send (ie: registration or confirmation). This affects the message
returned from the MP.
|
![]() |
ReplyType |
Reply type encapsulated by this
message (Inherited from
SynchronousMessageRequest.) |
![]() |
RequestedSmsId |
Get/Set the SMSID, leave null or emptystring
to let the MP generate one for you if you are registering. Must be
set if using for a confirmation request.
|
![]() |
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 message using the specified
sender (Inherited from
SynchronousMessageRequest
<
(Of
<
(
<'
TSynchronousReply
>
)
>
)
>
.) |
![]() |
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 () () () () |
Serializes the payload (Overrides
Message
.
.
::
.
.
SerializeMessageBody
()
()
()
()
.) |
![]() ![]() |
IMessageBase . . :: . . Settings |
Message settings and
properties (Inherited from
Message.) |
![]() |
Settings |
Message settings (Inherited from
Message.) |
![]() |
SigningCertificate |
Get/Set the certificate used to sign the
message and also serve as it's identity
|
![]() |
SigningSmsId |
Get/Set the SMSID that the signing the request
on behalf. (Only use if you're registering AgentType 4 or AgentType
8)
|
![]() |
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 |
Get/Set the SMSID to use for sending and
signing the message. (Inherited from
Message.) |
![]() |
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.) |
![]() |
Timestamp |
Timestamp for the registration 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. (Overrides
Message
.
.
::
.
.
Validate
()
()
()
()
.) |
Inheritance Hierarchy
System
.
.
::
.
.
Object
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . Message
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest < (Of < ( <' ConfigMgrRegistrationReply > ) > ) >
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . ConfigMgrRegistrationRequestBase
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . ConfigMgrRegistrationRequest
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . Message
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest
Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . SynchronousMessageRequest < (Of < ( <' ConfigMgrRegistrationReply > ) > ) >
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . ConfigMgrRegistrationRequestBase
Microsoft.ConfigurationManagement.Messaging.Messages . . :: . . ConfigMgrRegistrationRequest