API Reference

Class

AdmxExplorerBundle

Edit on GitHub

Namespace ADPlayground.Gpo.GpoLocal

Assembly ADPlayground

Source ADPlayground/GpoLocal/AdmxExplorerBundle.cs:56

Modifiers sealed

Loaded split ADMX explorer bundle with reusable query and policy hydration helpers.

Inheritance

Object
AdmxExplorerBundle

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Method AdmxExplorerBundleReader.Load

Methods

public IReadOnlyList<AdmxExplorerSearchEntry> FindEntries(AdmxExplorerQuery query = null) #

ADPlayground/GpoLocal/AdmxExplorerBundle.cs:56

Returns: IReadOnlyList<AdmxExplorerSearchEntry>

Finds search entries that match the supplied query.

Parameters

query ADPlayground.Gpo.GpoLocal.AdmxExplorerQuery = null optionalposition: 0: Query filters to apply. Null returns all entries.

Returns

Matching search entries in bundle order.

public static AdmxExplorerPolicyArtifactResult GetPolicyArtifact(AdmxCatalogPolicy policy, PolicyState state = Enabled, Nullable<PolicyScope> scope = null)

ADPlayground/GpoLocal/AdmxExplorerBundle.cs:223

Returns: AdmxExplorerPolicyArtifactResult

Resolves a generated deployment artifact from a hydrated policy.

Parameters

policy ADPlayground.Gpo.GpoLocal.AdmxCatalogPolicy requiredposition: 0: Hydrated policy loaded from a source payload.
state ADPlayground.Gpo.GpoLocal.PolicyState = Enabled optionalposition: 1: Requested policy state.
scope System.Nullable{ADPlayground.Gpo.GpoLocal.PolicyScope} = null optionalposition: 2: Optional scope. When null, the first generated scope for the policy is used.

Returns

Resolved policy deployment artifact.

LoadPolicy 2 overloads

public AdmxCatalogPolicy LoadPolicy(AdmxExplorerSearchEntry entry) #

ADPlayground/GpoLocal/AdmxExplorerBundle.cs:156

Returns: AdmxCatalogPolicy

Loads a full policy for the supplied search entry.

Parameters

entry ADPlayground.Gpo.GpoLocal.AdmxExplorerSearchEntry requiredposition: 0: Search entry that identifies the policy.

Returns

Full policy from the source payload.

public AdmxCatalogPolicy LoadPolicy(String policyId) #

ADPlayground/GpoLocal/AdmxExplorerBundle.cs:176

Returns: AdmxCatalogPolicy

Loads a full policy by identifier.

Parameters

policyId System.String requiredposition: 0: Policy identifier, usually Source.admx::PolicyName.

Returns

Full policy from the source payload.

LoadPolicyArtifact 2 overloads

public AdmxExplorerPolicyArtifactResult LoadPolicyArtifact(AdmxExplorerSearchEntry entry, PolicyState state = Enabled, Nullable<PolicyScope> scope = null)

ADPlayground/GpoLocal/AdmxExplorerBundle.cs:210

Returns: AdmxExplorerPolicyArtifactResult

Loads a generated deployment artifact by policy identifier, state, and optional scope.

Parameters

policyId System.String requiredposition: 0: Policy identifier, usually Source.admx::PolicyName.
state ADPlayground.Gpo.GpoLocal.PolicyState = Enabled optionalposition: 1: Requested policy state.
scope System.Nullable{ADPlayground.Gpo.GpoLocal.PolicyScope} = null optionalposition: 2: Optional scope. When null, the first generated scope for the policy is used.

Returns

Resolved policy deployment artifact.

LoadPolicyArtifact(ADPlayground.Gpo.GpoLocal.AdmxExplorerSearchEntry entry, ADPlayground.Gpo.GpoLocal.PolicyState state, System.Nullable{ADPlayground.Gpo.GpoLocal.PolicyScope} scope)

Loads a generated deployment artifact for a search entry.

Parameters

entry ADPlayground.Gpo.GpoLocal.AdmxExplorerSearchEntry required: Search entry that identifies the policy.
state ADPlayground.Gpo.GpoLocal.PolicyState required: Requested policy state.
scope System.Nullable{ADPlayground.Gpo.GpoLocal.PolicyScope} required: Optional scope. When null, the first generated scope for the policy is used.