UpdateScope Class

Article
10/10/2016

Applies To: Windows Server Update Services

Defines the filter for a list of updates.

Namespace: Microsoft.UpdateServices.Administration
Assembly: Microsoft.UpdateServices.Administration (in Microsoft.UpdateServices.Administration.dll)

Inheritance Hierarchy

System.Object
Microsoft.UpdateServices.Administration.UpdateScope

Syntax

public class UpdateScope

public ref class UpdateScope

type UpdateScope = class end

Public Class UpdateScope

Constructors

	Name	Description
	UpdateScope()	Initializes a new instance of UpdateScope.

Properties

	Name	Description
	ApprovedComputerTargetGroups	Gets the list of target groups to search for approvals. An update will be included only if it is approved for install or uninstall to at least one of these groups. If the list is empty, then no filtering will be done based on approved target groups. Defaults to empty.
	ApprovedStates	Gets or sets the approval states to search for. An update will be included only if it matches at least one of the specified states. This value may be a combination of any number of values from ApprovedStates. Defaults to Any.
	Categories	Gets or sets the list of update categories to search. An update will be included only if it belongs to at least one of these groups. If the list is empty, then no filtering will be done based on category; updates from all categories will be included. Defaults to empty.
	Classifications	Gets or sets the list of update classifications to search. An update will be included only if it belongs to at least one of these classifications. If the list is empty, then no filtering will be done based on classification; updates from all classifications will be included. Defaults to empty.
	ExcludedInstallationStates	Gets or sets the installation states to exclude. An update will be included only if it does not have any computers in any of the specified states. This value may be a combination of any number of values from UpdateInstallationStates. Defaults to 0.
	ExcludeOptionalUpdates	Gets or sets whether to exclude optional updates from the list.
	FromArrivalDate	Gets or sets the minimum arrival date to search for. An update will be included only if its arrival date is greater than or equal to this value.
	FromCreationDate	Gets or sets the minimum creation date to search for. An update will be included only if its creation date is greater than or equal to this value.
	IncludedInstallationStates	Gets or sets the installation states to search for. An update will be included only if it has at least one computer in one of the specified states. This value may be a combination of any number of values from UpdateInstallationStates.
	IsWsusInfrastructureUpdate	Gets or sets whether or not to filter for WSUS infrastructure updates. If set to true, only WSUS infrastructure updates will be included. If set to false, all updates are included. Defaults to false.
	TextIncludes	Gets or sets the string to search for. An update will be included only if its Title, Description, Knowledge Base articles, or security bulletins contains this string.
	TextNotIncludes	Gets or sets the string to exclude. An update will be not be included if its Title, Description, Knowledge Base articles, or security bulletins contains this string.
	ToArrivalDate	Gets or sets the maximum arrival date to search for. An update will be included only if its arrival date is less than or equal to this value.
	ToCreationDate	Gets or sets the maximum creation date to search for. An update will be included only if its creation date is less than or equal to this value.
	UpdateApprovalActions	Gets or sets the update approval actions to search for. An update will be included only if it is approved to at least one computer target group for one of the specified approval actions. This value may be a combination of any number of values from UpdateApprovalActions. Defaults to All.
	UpdateApprovalScope	Gets or sets the UpdateApprovalScope object that can be used to filter updates based on their approval properties.
	UpdateSources	Gets or sets the update sources to search for. An update will be included only if its update source is included in this value. This value may be a combination of any number of values from UpdateSources.
	UpdateTypes	Gets or sets the update types to search for. An update will be included only if its update type is included in this value.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

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.