New-M365DSCDeltaReport

Description

Compares source and destination configurations, evaluates drifted resources and properties, and renders a report in HTML or JSON format. Optional variable substitution support can be applied during comparison.

Output

This function does not generate any output.

Parameters

Parameter	Required	DataType	Default Value	Allowed Values	Description
Source	True	String			Specifies the source configuration file path.
Destination	True	String			Specifies the destination configuration file path.
OutputPath	False	String			Specifies the destination report file path.
DriftOnly	False	Boolean			Indicates that only drifted properties should be included.
IsBlueprintAssessment	False	Boolean			Indicates that report generation is running as a blueprint assessment.
HeaderFilePath	False	String			Specifies a custom header file path for HTML output.
Delta	False	Array			Specifies a precomputed delta structure to render.
Type	False	String	HTML	HTML, JSON	Specifies the report format.
ExcludedProperties	False	Array			Specifies property names to exclude from comparison.
ExcludedResources	False	Array			Specifies resource names to exclude from comparison.
UseVariableSubstitution	False	SwitchParameter			Indicates that variable substitution should be applied during comparison.
SourceConfigurationDataPath	False	String			Specifies the source configuration data file path used for substitution.
DestinationConfigurationDataPath	False	String			Specifies the destination configuration data file path used for substitution.
ExcludedSubstitutionProperties	False	String[]			Specifies property names excluded from variable substitution.
resource	False	Object
resource	False	Object
resource	False	Object

Examples

-------------------------- EXAMPLE 1 --------------------------

New-M365DSCDeltaReport -Source 'C:\DSC\Source.ps1' -Destination 'C:\DSC\Destination.ps1' -OutputPath 'C:\DSC\DeltaReport.html'

-------------------------- EXAMPLE 2 --------------------------

New-M365DSCDeltaReport -Source 'C:\DSC\Source.ps1' -Destination 'C:\DSC\Destination.ps1' -OutputPath 'C:\DSC\DeltaReport.html' -DriftOnly $true

-------------------------- EXAMPLE 3 --------------------------

New-M365DSCDeltaReport -Source 'C:\DSC\Source.ps1' -Destination 'C:\DSC\Destination.ps1' -OutputPath 'C:\DSC\DeltaReport.html' -IsBlueprintAssessment $true

-------------------------- EXAMPLE 4 --------------------------

New-M365DSCDeltaReport -Source 'C:\DSC\Source.ps1' -Destination 'C:\DSC\Destination.ps1' -OutputPath 'C:\DSC\DeltaReport.html' -HeaderFilePath 'C:\DSC\CustomHeader.html' -SourceConfigurationDataPath 'C:\DSC\SourceConfigData.psd1' -DestinationConfigurationDataPath 'C:\DSC\DestinationConfigData.psd1' -ExcludedSubstitutionProperties @('TenantEnvironment')`