Dependencies/Assemblies/Microsoft365DSC.Compare.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft365DSC.Compare</name> </assembly> <members> <member name="T:Microsoft365DSC.Compare.ComplexObjectComparer"> <summary> Provides comprehensive comparison of complex M365DSC objects for drift detection. Supports hashtables, PSObjects, CIM instances, arrays, and nested structures. </summary> </member> <member name="M:Microsoft365DSC.Compare.ComplexObjectComparer.Compare(System.Object,System.Object,System.String,System.Collections.Generic.HashSet{System.String})"> <summary> Compares two complex M365DSC objects to detect configuration drift. </summary> <param name="source">Source (desired) object</param> <param name="target">Target (current) object</param> <param name="propertyName">Property name for drift reporting</param> <param name="excludedSet">Property names to skip during comparison</param> <returns>The drifts found and true when the objects are identical</returns> </member> <member name="T:Microsoft365DSC.Compare.ConfigurationComparer"> <summary> Compares two whole configurations by pairing their resource instances by key, diffs each pair with <see cref="T:Microsoft365DSC.Compare.ResourceComparer"/>, and reports instances that exist on only one side. </summary> </member> <member name="F:Microsoft365DSC.Compare.ConfigurationComparer.PresenceMarker"> <summary> Marks a resource that is not present on both sides, as opposed to a property that differs. </summary> </member> <member name="M:Microsoft365DSC.Compare.ConfigurationComparer.Compare(System.Collections.Generic.IEnumerable{System.Object},System.Collections.Generic.IEnumerable{System.Object},System.Collections.Generic.IEnumerable{System.Object},System.String[],System.String[],System.Collections.Generic.IDictionary{System.String,Microsoft365DSC.Compare.ResourceCompareParameters})"> <summary> Compares a source configuration against a destination configuration. </summary> <param name="source">Parsed resources of the source, each a hashtable carrying ResourceName.</param> <param name="destination">Parsed resources of the destination, in the same shape.</param> <param name="schema">The deserialized SchemaDefinition.json.</param> <param name="excludedProperties">Property names to skip on every resource.</param> <param name="excludedResources">Resource names to skip entirely.</param> <param name="compareParameters"> Per-resource comparison overrides, keyed by resource name. Merged with the schema's own declarations, and the only way to supply a post-processing callback, which cannot be expressed in the schema. </param> <returns>One entry per differing property, plus one per resource missing on either side.</returns> </member> <member name="M:Microsoft365DSC.Compare.ConfigurationComparer.ApplyAnnotation(Microsoft365DSC.Compare.ConfigurationDeltaProperty,System.Collections.Hashtable,System.String)"> <summary> Copies a blueprint annotation onto the drift it explains. The comment travels with the destination resource as "_metadata_<Property>" holding "### Level|Information". </summary> </member> <member name="M:Microsoft365DSC.Compare.ConfigurationComparer.ApplyPresenceAnnotation(Microsoft365DSC.Compare.ConfigurationDeltaProperty,System.Collections.Hashtable,System.String[])"> <summary> Copies the blueprint annotation of a resource missing from the source onto its presence delta. The annotation on Ensure wins, then the first annotated key property. </summary> </member> <member name="T:Microsoft365DSC.Compare.ConfigurationDelta"> <summary> One resource instance's difference between two configurations. </summary> </member> <member name="P:Microsoft365DSC.Compare.ConfigurationDelta.Key"> <summary>The property names the instance is identified by, backslash separated.</summary> </member> <member name="M:Microsoft365DSC.Compare.ConfigurationDelta.ToHashtable"> <summary> Projects the entry into the shape PowerShell callers render and serialize. </summary> </member> <member name="T:Microsoft365DSC.Compare.ConfigurationDeltaProperty"> <summary> One differing property, or the presence marker when the resource is missing on a side. </summary> </member> <member name="P:Microsoft365DSC.Compare.ConfigurationDeltaProperty.DeltaValue"> <summary>Set only for collection drifts, holding the added and removed entries.</summary> </member> <member name="P:Microsoft365DSC.Compare.ConfigurationDeltaProperty.MetadataLevel"> <summary>Blueprint severity of the annotated property, when the destination carries one.</summary> </member> <member name="T:Microsoft365DSC.Compare.ResourceCompareParameters"> <summary> Per-resource overrides of how its instances are compared. </summary> </member> <member name="P:Microsoft365DSC.Compare.ResourceCompareParameters.PostProcessing"> <summary> Rewrites desired, current and checked values before the diff. Supplied by the resource itself, so it exists only where a caller can run the resource's own code. </summary> </member> <member name="T:Microsoft365DSC.Compare.IntunePolicyAssignmentComparer"> <summary> Compares Intune policy assignments between source and target arrays. </summary> </member> <member name="M:Microsoft365DSC.Compare.IntunePolicyAssignmentComparer.Compare(System.Array,System.Array,System.Collections.Generic.List{System.Collections.Hashtable})"> <summary> Compares two arrays of Intune policy assignments and identifies drifts. </summary> <param name="source">The source array of assignments (desired state)</param> <param name="target">The target array of assignments (current state)</param> <param name="drifts">List to collect drift information</param> <returns>True if assignments match, false otherwise</returns> </member> <member name="M:Microsoft365DSC.Compare.IntunePolicyAssignmentComparer.CompareFilters(System.Collections.Hashtable,System.Collections.Hashtable,System.Int32,System.Collections.Generic.List{System.Collections.Hashtable})"> <summary> Compares filter settings between source and target assignments. </summary> </member> <member name="M:Microsoft365DSC.Compare.IntunePolicyAssignmentComparer.FindAssignmentTarget(System.Collections.Hashtable[],System.String,System.String)"> <summary> Finds an assignment target in the array by property value </summary> </member> <member name="M:Microsoft365DSC.Compare.IntunePolicyAssignmentComparer.GetPropertyValue``1(System.Collections.Hashtable,System.String)"> <summary> Gets a typed property value from a hashtable with null safety. </summary> </member> <member name="T:Microsoft365DSC.Compare.PrimaryKeyPairing"> <summary> Aligns the elements of two complex arrays by the primary keys their CIM class declares. A drift is then reported against the element that carries it, not against the element that shares its index. </summary> </member> <member name="T:Microsoft365DSC.Compare.ResourceComparer"> <summary> High-level resource comparison entry point. Normalizes both sides to Hashtable trees, resolves schema metadata, aligns complex arrays by primary keys, then delegates to ComplexObjectComparer and SimpleObjectComparer for the actual diff. </summary> </member> <member name="F:Microsoft365DSC.Compare.ResourceComparer.AlwaysExcludedProperties"> <summary> Names dropped from the resource's own parameter set. They carry no meaning below the top level, where a nested Id identifies the referenced object rather than the resource. </summary> </member> <member name="M:Microsoft365DSC.Compare.ResourceComparer.Compare(System.Collections.Hashtable,System.Collections.Hashtable,System.Collections.Hashtable,System.Collections.Generic.IEnumerable{System.Object},System.String,System.String[],System.String[])"> <summary> Compares desired vs current values for a single DSC resource. Both sides are normalized to Hashtable trees before comparison. </summary> <param name="desiredValues">Desired state hashtable (from PSBoundParameters)</param> <param name="currentValues">Current state hashtable (from Get-TargetResource)</param> <param name="valuesToCheck">Subset of keys from desiredValues to check (after filtering out keys/credentials/excluded)</param> <param name="schema">The full schema array (deserialized SchemaDefinition.json)</param> <param name="resourceName">Resource name without MSFT_ prefix (e.g. "AADUser")</param> <param name="excludedProperties">Properties to skip during comparison</param> <param name="includedProperties">Properties to force-include even if otherwise skipped</param> <returns>A CompareResult with test result, drift info, and value snapshots</returns> </member> <member name="T:Microsoft365DSC.Compare.CompareResult"> <summary> Result object for ResourceComparer.Compare. Contains the test result (true = no drift), drift info entries, and drifted parameter event strings for telemetry. </summary> </member> <member name="P:Microsoft365DSC.Compare.CompareResult.TestResult"> <summary> True if no drift was detected; false otherwise. </summary> </member> <member name="P:Microsoft365DSC.Compare.CompareResult.DriftInfo"> <summary> List of drift entries. Each entry has PropertyName, CurrentValue, DesiredValue. </summary> </member> <member name="P:Microsoft365DSC.Compare.CompareResult.DriftedParameters"> <summary> Drifted parameter event strings for telemetry (key = param name, value = XML snippet). </summary> </member> <member name="M:Microsoft365DSC.Compare.CompareResult.AddDrift(System.String,System.Object,System.Object)"> <summary> Adds a drift entry. </summary> </member> <member name="T:Microsoft365DSC.Compare.ResourceKeyResolver"> <summary> Decides which properties identify one instance of a resource, so two configurations can be paired instance by instance before their values are compared. </summary> </member> <member name="M:Microsoft365DSC.Compare.ResourceKeyResolver.Resolve(System.Collections.Hashtable,System.Collections.Generic.IEnumerable{System.Object})"> <summary> Resolves the key property names for a parsed resource instance. </summary> <param name="resource"> A parsed resource, including its ResourceName. Its shape decides branches the schema alone cannot, such as whether an AADGroup carries a MailNickname. </param> <param name="schema">The deserialized SchemaDefinition.json.</param> <returns>The key property names, or an empty array when the resource declares none.</returns> </member> <member name="T:Microsoft365DSC.Compare.SchemaIndex"> <summary> Random access over a deserialized SchemaDefinition.json. One index is built per schema list and shared by every comparison that receives that same list. </summary> </member> </members> </doc> |