API Reference
WmiFilterService
Provides operations for managing GPO WMI filters.
Inheritance
- Object
- WmiFilterService
Methods
public static GpoWmiFilter CreateFilter(String name, IEnumerable<WmiFilterQuery> queries, String description = null, String domainName = null) #GpoWmiFilterCreates a WMI filter in the specified or current domain.
Parameters
- name System.String
- query System.String
- description System.String = null
- domainName System.String = null
CreateFilter(System.String name, System.Collections.Generic.IEnumerable{ADPlayground.Gpo.WmiFilterQuery} queries, System.String description, System.String domainName) #Creates a WMI filter with multiple queries in the specified or current domain.
Parameters
- name System.String
- queries System.Collections.Generic.IEnumerable{ADPlayground.Gpo.WmiFilterQuery}
- description System.String
- domainName System.String
public static Task<GpoWmiFilter> CreateFilterAsync(String name, IEnumerable<WmiFilterQuery> queries, String description = null, String domainName = null) #Task<GpoWmiFilter>Asynchronously creates a WMI filter.
Parameters
- name System.String
- query System.String
- description System.String = null
- domainName System.String = null
CreateFilterAsync(System.String name, System.Collections.Generic.IEnumerable{ADPlayground.Gpo.WmiFilterQuery} queries, System.String description, System.String domainName) #Asynchronously creates a WMI filter with multiple queries.
Parameters
- name System.String
- queries System.Collections.Generic.IEnumerable{ADPlayground.Gpo.WmiFilterQuery}
- description System.String
- domainName System.String
public static IEnumerable<GpoWmiFilter> EnumerateFilters(String domainName = null, CancellationToken cancellationToken = null) #IEnumerable<GpoWmiFilter>Enumerates WMI filters in the specified domain or current domain when domainName is null.
Parameters
- domainName System.String = null
- cancellationToken System.Threading.CancellationToken = null
public static Task<IEnumerable<GpoWmiFilter>> EnumerateFiltersAsync(String domainName = null, CancellationToken cancellationToken = null) #Task<IEnumerable<GpoWmiFilter>>Asynchronously enumerates WMI filters in the specified domain or current domain when domainName is null.
Parameters
- domainName System.String = null
- cancellationToken System.Threading.CancellationToken = null
public static GpoWmiFilter GetFilterByDistinguishedName(String filterDn, String domainName) #GpoWmiFilterRetrieves a WMI filter by its distinguished name.
Parameters
- filterDn System.String
- domainName System.String
public static GpoWmiFilter GetFilterByName(String displayName, String domainName) #GpoWmiFilterRetrieves a WMI filter by its display name.
Parameters
- displayName System.String
- domainName System.String
public static Boolean LinkFilterToGpo(Guid filterId, Guid gpoId, String domainName = null) #BooleanLinks a WMI filter to a GPO.
Parameters
- filterId System.Guid
- gpoId System.Guid
- domainName System.String = null
public static Task<Boolean> LinkFilterToGpoAsync(Guid filterId, Guid gpoId, String domainName = null) #Task<Boolean>Asynchronously links a WMI filter to a GPO.
Parameters
- filterId System.Guid
- gpoId System.Guid
- domainName System.String = null
public static Boolean RemoveFilter(String displayName, String domainName) #BooleanRemoves a WMI filter by its display name.
Parameters
- displayName System.String
- domainName System.String
public static Boolean RemoveFilter(Guid id, String domainName = null) #BooleanRemoves the WMI filter with the specified identifier.
Parameters
- id System.Guid
- domainName System.String = null
public static Task<Boolean> RemoveFilterAsync(Guid id, String domainName = null) #Task<Boolean>Asynchronously removes the WMI filter with the specified identifier.
Parameters
- id System.Guid
- domainName System.String = null
public static Boolean TryExtractFilterDn(String linkValue, out String filterDn) #BooleanExtracts the WMI filter distinguishedName (DN) from a gPCWQLFilter/gPCWMIFilter link value. Supported formats: - "LDAP://host/<DN>;domain" - "<DN>;domain" - "<DN>" - Legacy gPCWMIFilter: "[domain];{GUID};rev" or "[domain;{GUID};rev]"
Parameters
- linkValue System.String
- filterDn System.String@
public static GpoWmiFilter UpdateFilter(String displayName, IEnumerable<WmiFilterQuery> queries, String description = null, String domainName = null) #GpoWmiFilterUpdates a WMI filter by its display name.
Parameters
- displayName System.String
- queries System.Collections.Generic.IEnumerable{ADPlayground.Gpo.WmiFilterQuery}
- description System.String = null
- domainName System.String = null
public static Boolean ValidateNamespace(String wmiNamespace) #BooleanValidates that a WMI namespace follows expected format.
Parameters
- wmiNamespace System.String
public static Boolean ValidateQuery(WmiFilterQuery query) #BooleanValidates that a WMI query uses basic WQL syntax.
Parameters
- query ADPlayground.Gpo.WmiFilterQuery
public static Task<Boolean> ValidateQueryAsync(WmiFilterQuery query) #Task<Boolean>Asynchronously validates that a WMI query uses basic WQL syntax.
Parameters
- query ADPlayground.Gpo.WmiFilterQuery
Inherited Methods
Fields
public const String DefaultNamespace #Default WMI namespace used when none is specified in existing filters.
root\CIMv2