Assert-M365DSCBlueprint

Description

Downloads or opens a blueprint file, exports matching tenant resources, and generates a delta report showing drift between blueprint and tenant state.

Output

This function does not generate any output.

Parameters

Parameter	Required	DataType	Default Value	Allowed Values	Description
BluePrintUrl	True	String			Specifies the blueprint URL or local path.
OutputReportPath	True	String			Specifies the output path of the generated report.
Credentials	False	PSCredential			Specifies delegated credentials used for authentication.
ApplicationId	False	String			Specifies the application id used for app-based authentication.
TenantId	False	String			Specifies the tenant id or tenant domain used for authentication.
ApplicationSecret	False	PSCredential			Specifies the application secret used for app-based authentication.
CertificatePath	False	String			Specifies the certificate path used for app-based authentication.
CertificatePassword	False	PSCredential			Specifies the certificate password used for app-based authentication.
CertificateThumbprint	False	String			Specifies the certificate thumbprint used for app-based authentication.
ManagedIdentity	False	SwitchParameter			Indicates that managed identity authentication should be used.
AccessTokens	False	String[]			Specifies access tokens used for authentication.
HeaderFilePath	False	String			Specifies a custom report header file path.
Type	False	String	HTML	HTML, JSON	Specifies the delta report output type.
ExcludedProperties	False	String[]			Specifies property names to exclude from comparison.
ExcludedResources	False	String[]			Specifies resource names to exclude from comparison.
DriftOnly	False	Boolean			Indicates that only drifts should be included in the report.
KeepExport	False	Boolean			Indicates that the temporary export should be retained.
UseVariableSubstitution	False	SwitchParameter			Indicates that variable substitution should be applied during comparison.
SourceConfigurationDataPath	False	String			Specifies source configuration data for variable substitution.
DestinationConfigurationDataPath	False	String			Specifies destination configuration data for variable substitution.
ExcludedSubstitutionProperties	False	String[]			Specifies properties excluded from substitution.
Parallel	False	SwitchParameter			Indicates that export should run in parallel.

Examples

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

Assert-M365DSCBlueprint -BluePrintUrl 'C:\DS\blueprint.m365' -OutputReportPath 'C:\DSC\BlueprintReport.html'

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

Assert-M365DSCBlueprint -BluePrintUrl 'C:\DS\blueprint.m365' -OutputReportPath 'C:\DSC\BlueprintReport.html' -Credentials $credentials -HeaderFilePath 'C:\DSC\ReportCustomHeader.html'

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

Assert-M365DSCBlueprint -BluePrintUrl 'C:\DS\blueprint.m365' -OutputReportPath 'C:\DSC\BlueprintReport.html' -ApplicationId $clientid -TenantId $tenantId -CertificateThumbprint $certthumbprint -HeaderFilePath 'C:\DSC\ReportCustomHeader.html'

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

Assert-M365DSCBlueprint -BluePrintUrl 'C:\DS\blueprint.m365' -OutputReportPath 'C:\DSC\BlueprintReport.html' -KeepExport $true