[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Registers a client with the site

Namespace:  Microsoft.ConfigurationManagement.Messaging.Messages
Assembly:  Microsoft.ConfigurationManagement.Messaging(in Microsoft.ConfigurationManagement.Messaging.dll)

Syntax

                 
  C#     Visual Basic     Visual C++  

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
ConfigMgrRegistrationRequest () () () ()
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.
(Inherited from ConfigMgrRegistrationRequestBase.)
AgentIdentity
Get/Set agent identity. Usually somthing like "MyClient.exe"
(Inherited from ConfigMgrRegistrationRequestBase.)
AgentType
Get/Set the agent type. Current valid agent types are 0=AdvancedClient, 1=OsdCD, 2=Device, 4=IsvProxy, 8=IsvProxyClient
(Inherited from ConfigMgrRegistrationRequestBase.)
AgentVersion
Get/Set the agent version. Defaults to null
(Inherited from ConfigMgrRegistrationRequestBase.)
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.
(Inherited from ConfigMgrRegistrationRequestBase.)
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
(Inherited from ConfigMgrRegistrationRequestBase.)
CreateConfirmationRequestCallback(ClientRegistrationRequestData)
Callback for changes for registration request creation before signing occurs
(Inherited from ConfigMgrRegistrationRequestBase.)
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)
(Inherited from ConfigMgrRegistrationRequestBase.)
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
(Inherited from ConfigMgrRegistrationRequestBase.)
CreateRegistrationRequest () () () ()
Creates registration request
(Inherited from ConfigMgrRegistrationRequestBase.)
CreateRegistrationRequestCallback(ClientRegistrationRequestData)
Callback for special changes for registration request creation before signing occurs
(Inherited from ConfigMgrRegistrationRequestBase.)
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
(Inherited from ConfigMgrRegistrationRequestBase.)
DiscoveryProperties
Get/Set the discovery properties. This is not used in confirmation requests.
(Inherited from ConfigMgrRegistrationRequestBase.)
Edition
Client edition
EncryptionCertificate
The encryption certificate used to include in the registration request
(Inherited from ConfigMgrRegistrationRequestBase.)
Equals(Object) (Inherited from Object.)
ExchangeDeviceId
Exchange device ID
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.
(Inherited from ConfigMgrRegistrationRequestBase.)
InternetStatus
Client's Internet status. Defaults to None (0)
(Inherited from ConfigMgrRegistrationRequestBase.)
LocaleId
The locale ID of the registering machine. Defaults to the locale ID of the calling machine.
(Inherited from ConfigMgrRegistrationRequestBase.)
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.
(Inherited from ConfigMgrRegistrationRequestBase.)
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.)
PublisherDeviceId
Publisher device ID
RegisterClient(IMessageSender, TimeSpan)
Helper method to perform a registration loop for a new client
(Inherited from ConfigMgrRegistrationRequestBase.)
RegistrationHint
Gets or sets the registration hint to use for registering with the site server.
(Inherited from ConfigMgrRegistrationRequestBase.)
RegistrationRequest
Registration request object
(Inherited from ConfigMgrRegistrationRequestBase.)
RegistrationType
Get or set the type of registration message to send (ie: registration or confirmation). This affects the message returned from the MP.
(Inherited from ConfigMgrRegistrationRequestBase.)
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.
(Inherited from ConfigMgrRegistrationRequestBase.)
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 ConfigMgrRegistrationRequestBase . . :: . . 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
(Inherited from ConfigMgrRegistrationRequestBase.)
SigningSmsId
Get/Set the SMSID that the signing the request on behalf. (Only use if you're registering AgentType 4 or AgentType 8)
(Inherited from ConfigMgrRegistrationRequestBase.)
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
(Inherited from ConfigMgrRegistrationRequestBase.)
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 ConfigMgrRegistrationRequestBase.)

Examples

Copy imageCopy Code 
				// HTTP sender is used for sending messages to the
MP
				HttpSender sender = new HttpSender();
				// Load the certificate for client authentication
				using (MessageCertificateX509Volatile certificate =
new
MessageCertificateX509Volatile(File.ReadAllBytes("MixedModeTestCert.pfx"),
"sccm" /* sample cert password */))
				{
					// Create a registration request
					ConfigMgrRegistrationRequest
registrationRequest = new ConfigMgrRegistrationRequest();
					// Add our certificate for message signing
				 
registrationRequest.AddCertificateToMessage(certificate,
CertificatePurposes.Signing);
					// Set the destination hostname
					registrationRequest.Settings.HostName =
MPHostname;
					// Discover local properties for registration
metadata
					registrationRequest.Discover();
					// Register client and wait for a confirmation
with the SMSID
					SmsClientId clientId =
registrationRequest.RegisterClient(sender,
TimeSpan.FromMinutes(5));
					// Send data to the site
					SendSiteData(certificate, clientId, sender);
			}

Inheritance Hierarchy

See Also