TestimoX

API Reference

Class

AdmxProviderCacheService

Edit on GitHub
Namespace ADPlayground.Gpo.GpoLocal
Assembly ADPlayground
Source ADPlayground/GpoLocal/AdmxProviderCacheService.cs:26
Modifiers static

Builds a normalized on-disk cache of ADMX provider releases that can be validated, searched, and compared with SYSVOL.

Inheritance

  • Object
  • AdmxProviderCacheService

Methods

public static AdmxProviderFileIdentityIndex BuildFileIdentityIndex(String cacheRoot = null) #
ADPlayground/GpoLocal/AdmxProviderCacheService.cs:414
Returns: AdmxProviderFileIdentityIndex

Rebuilds the generated provider file identity index from catalog history and cached files.

Parameters

cacheRoot System.String = null optionalposition: 0
Optional cache root. Defaults to ProgramData\ADPlayground\AdmxProviderCache.

Returns

Generated file identity index.

public static AdmxProviderCacheComparison Compare(AdmxProviderCacheComparisonOptions options) #
ADPlayground/GpoLocal/AdmxProviderCacheService.cs:242
Returns: AdmxProviderCacheComparison

Compares a normalized provider cache PolicyDefinitions folder with a destination PolicyDefinitions folder.

Parameters

options ADPlayground.Gpo.GpoLocal.AdmxProviderCacheComparisonOptions requiredposition: 0
Comparison options.

Returns

File-level comparison result.

public static String GetDefaultCacheRoot() #
ADPlayground/GpoLocal/AdmxProviderCacheService.cs:26
Returns: String

Returns the default local ADMX provider cache root.

Returns

ProgramData-based cache path, or a temp path when ProgramData is unavailable.

public static AdmxProviderCatalogEntry GetLatestCatalogEntry(String cacheRoot, String providerName) #
ADPlayground/GpoLocal/AdmxProviderCacheService.cs:376
Returns: AdmxProviderCatalogEntry

Gets the latest maintained catalog entry for a provider.

Parameters

cacheRoot System.String requiredposition: 0
Optional cache root. Defaults to ProgramData\ADPlayground\AdmxProviderCache.
providerName System.String requiredposition: 1
Provider name to resolve.

Returns

Latest catalog entry, or null when the provider has not been cached.

public static String GetProviderCacheIdentity(AdmxProvider provider, AdmxEdgeChannel edgeChannel) #
ADPlayground/GpoLocal/AdmxProviderCacheService.cs:512
Returns: String

Builds the catalog/cache identity for a built-in provider and its selected channel.

Parameters

provider ADPlayground.Gpo.GpoLocal.AdmxProvider requiredposition: 0
Built-in ADMX provider.
edgeChannel ADPlayground.Gpo.GpoLocal.AdmxEdgeChannel requiredposition: 1
Edge channel used when provider is Edge.

Returns

Provider identity suitable for cache paths and catalog lookups.

public static AdmxProviderCatalog LoadCatalog(String cacheRoot = null) #
ADPlayground/GpoLocal/AdmxProviderCacheService.cs:346
Returns: AdmxProviderCatalog

Loads the maintained provider cache catalog from disk.

Parameters

cacheRoot System.String = null optionalposition: 0
Optional cache root. Defaults to ProgramData\ADPlayground\AdmxProviderCache.

Returns

Catalog with latest entries and refresh history.

public static AdmxProviderFileIdentityIndex LoadFileIdentityIndex(String cacheRoot = null) #
ADPlayground/GpoLocal/AdmxProviderCacheService.cs:393
Returns: AdmxProviderFileIdentityIndex

Loads the generated provider file identity index from disk, or returns an empty index when it has not been generated.

Parameters

cacheRoot System.String = null optionalposition: 0
Optional cache root. Defaults to ProgramData\ADPlayground\AdmxProviderCache.

Returns

Generated file identity index.

public static async Task<AdmxProviderCacheResult> SaveAsync(String providerName, AdmxRelease release, AdmxProviderCacheOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task<AdmxProviderCacheResult>

Downloads or harvests a provider release into a normalized PolicyDefinitions cache folder.

Parameters

providerName System.String requiredposition: 0
Displayable provider name used in the cache path.
release ADPlayground.Gpo.GpoLocal.AdmxRelease requiredposition: 1
Release metadata and source assets.
options ADPlayground.Gpo.GpoLocal.AdmxProviderCacheOptions = null optionalposition: 2
Cache refresh options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
Cancellation token for network and file-copy work.

Returns

Cache result with copied files and health diagnostics.