New-M365DSCDeltaReport¶
Description¶
This function creates a delta HTML report between two provided exported DSC configurations
Output¶
This function does not generate any output.
Parameters¶
| Parameter | Required | DataType | Default Value | Allowed Values | Description |
|---|---|---|---|---|---|
| Source | True | String | The source DSC configuration to compare from. | ||
| Destination | True | String | The destination DSC configuration to compare with. | ||
| OutputPath | False | String | The output path of the delta report. | ||
| DriftOnly | False | Boolean | Specifies that only difference should be in the report. | ||
| IsBlueprintAssessment | False | Boolean | Specifies that the report is a comparison with a Blueprint. | ||
| HeaderFilePath | False | String | Specifies that file that contains a custom header for the report. | ||
| Delta | False | Array | An array with difference, already compiled from another source. | ||
| Type | False | String | HTML | HTML, JSON | The type of report that should be created: HTML or JSON. |
| ExcludedProperties | False | Array | Array that contains the list of parameters to exclude. | ||
| ExcludedResources | False | Array | Array that contains the list of resources to exclude. | ||
| UseVariableSubstitution | False | SwitchParameter | Switch that indicates whether variable substitution should be used in the report. | ||
| SourceConfigurationDataPath | False | String | The path to the ConfigurationData.psd1 file that belongs to the source configuration, used for variable substitution in the report. | ||
| DestinationConfigurationDataPath | False | String | The path to the ConfigurationData.psd1 file that belongs to the destination configuration, used for variable substitution in the report. | ||
| ExcludedSubstitutionProperties | False | String[] | Array that contains the list of properties for which variable substitution should be excluded. Authentication properties are always excluded, with additional properties that can be specified through this parameter. | ||
| 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')`