ConfigMgrRegistrationRequestBase Class

 

Base class used for creating System Center Configuration Manager client registration requests

Registration is different in Configuration Manager 2007 versus System Center 2012 Configuration Manager; ensure that you use the appropriate library for this request.

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.ConfigMgrRegistrationRequestBase
          Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrRegistrationRequest

Syntax

[SerializableAttribute]
[MessageClassAttribute(MessageClassAttributeSetting.NotSigned)]
[MessageSupportAttribute(MessageSupportStatus.Supported)]
public abstract class ConfigMgrRegistrationRequestBase : SynchronousMessageRequest<ConfigMgrRegistrationReply>

[SerializableAttribute]
[MessageClassAttribute(MessageClassAttributeSetting::NotSigned)]
[MessageSupportAttribute(MessageSupportStatus::Supported)]
public ref class ConfigMgrRegistrationRequestBase abstract : SynchronousMessageRequest<ConfigMgrRegistrationReply^>

<SerializableAttribute>
<MessageClassAttribute(MessageClassAttributeSetting.NotSigned)>
<MessageSupportAttribute(MessageSupportStatus.Supported)>
Public MustInherit Class ConfigMgrRegistrationRequestBase
    Inherits SynchronousMessageRequest(Of ConfigMgrRegistrationReply)

Properties

	Name	Description
	AddRegistrationHint	If true, a registration hint will be added to the message before it is sent.
	AgentIdentity	Gets or sets the agent identity. An example of agent identity is "MyClient.exe".
	AgentType	Getor sets the agent type. Valid agent types are 0=AdvancedClient, 1=OsdCD, 2=Device, 4=IsvProxy, 8=IsvProxyClient.
	AgentVersion	Get or sets the agent version. The default value is null.
	Attachments	Gets message attachments. (Inherited from Message.)
	Body	Gets the message body. This property should not be empty, with limited exceptions.(Inherited from Message.)
	ClientFqdn	Gets or sets the client FQDN of the registering machine. If you don't set this property, the NetBiosName value is used.
	DiscoveryProperties	Gets or sets the discovery properties. This property is not used in confirmation requests.
	EncryptionCertificate	Gets the encryption certificate to include in the registration request.
	HardwareId	Gets or sets the hardware ID of the registering machine. Hardware IDs are used to identify the machine hardware. Any string provided will suffice as a hardware ID, as long as it's unique to the machine.
	InternetStatus	Gets or sets the Internet status of the client. The default value is None (0).
	LocaleId	Gets or sets the locale ID of the registering machine. The default value is the locale ID of the calling machine.
	MessageId	Gets the internal ID of a message. (Inherited from Message.)
	NetBiosName	Gets or sets the NetBIOS name of the registering machine. This property is required.
	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.)
	RegistrationHint	Gets or sets the registration hint to use when registering with the site server.
	RegistrationRequest	Gets or sets the registration request object.
	RegistrationType	Gets or sets the type of registration message to send, such as registration or confirmation. This property affects the message returned from the management point.
	ReplyType	Gets the reply type encapsulated by the message. (Inherited from SynchronousMessageRequest.)
	RequestedSmsId	Gets or sets the SMSID. If you are using this property to register, set the value to null or an empty string to allow the management point to generate an SMSID for you. If you are using this property for a confirmation request, you must set a value.
	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.)
	SigningCertificate	Gets or sets the certificate used to sign the message and serve as the message's identity.
	SigningSmsId	Gets or sets the SMSID for the client on behalf of which the signing request was made. Use this property only if you are registering AgentType 4 or AgentType 8.
	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 to use for signing and sending a message. (Inherited from Message.)
	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.)
	Timestamp	Gets or sets the timestamp for the registration 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.)
	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.)
	CreateConfirmationRequest()	Creates a confirmation request.
	CreateConfirmationRequestCallback(ClientRegistrationRequestData)	Creates a callback for changes to registration request creation before signing occurs.
	CreateRegistrationHint()	Creates a registration hint by 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 properties to be set: SmsId (checked first), SigningSmsId (checked second), RequestedSmsId (checked last).
	CreateRegistrationHint(SmsClientId)	Creates a registration hint by using the signing certificate assigned to the registration request, and assigns the public property, RegistrationHint, with the generated hint.
	CreateRegistrationRequest()	Creates a registration request.
	CreateRegistrationRequestCallback(ClientRegistrationRequestData)	Creates a callback for special changes to registration request creation before signing occurs.
	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. (Overrides Message.Discover().)
	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()	Actions that run before the message is sent. This operation is synchronous and blocking. (Inherited from Message.)
	RegisterClient(ConfigMgrRegistrationRequestBase, IMessageSender, TimeSpan)	Helper method that performs a registration loop for a new client.
	RegisterClient(IMessageSender, TimeSpan)	Helper method that performs a registration loop for a new client.
	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 SynchronousMessageRequest<TSynchronousReply>.)
	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 Message.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. (Overrides Message.Validate(IMessageSender).)

Fields

	Name	Description
	Synchronizer	Synchronizer to use for locking in thread-safe operations. (Inherited from Message.)

Explicit Interface Implementations

	Name	Description
	IMessage.SendMessage(IMessageSender)	Sends a message by using the specified sender. (Inherited from Message.)
	IMessageBase.Settings	Gets message properties and settings. (Inherited from Message.)

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