Skip to content

Invoke-M365DSCConfigurationBuild

Description

Uses the fast compile host of the M365DSC.PSDesiredStateConfiguration engine when installed (seconds instead of minutes for class-based resources) and falls back to standard compilation otherwise.

Output

This function outputs information as the following type: System.IO.FileInfo

Parameters

Parameter Required DataType Default Value Allowed Values Description
Path False String .\M365TenantConfig.ps1 Path to the exported configuration script. Defaults to .\M365TenantConfig.ps1.
ConfigurationDataPath False String Path to the configuration data .psd1. Defaults to ConfigurationData.psd1 next to the configuration script when present.
ConfigurationData False Object Configuration data as an in-memory hashtable, for callers that do not have it on disk. Takes precedence over ConfigurationDataPath.
ConfigurationName False String Name of the configuration to compile. Required when the script only declares a configuration instead of invoking one.
Credential False PSCredential Credential forwarded to the configuration's -Credential parameter.
CertificatePassword False PSCredential CertificatePassword forwarded to the configuration's -CertificatePassword parameter.
Parameters False Hashtable Additional parameters splatted onto the configuration invocation.
Engine False String Auto Auto, FastHost, Standard Auto (default) uses the fast host when available; FastHost requires it; Standard always compiles through the standard configuration pipeline.
OutputPath False String Folder for the generated MOF files.

Examples

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

Invoke-M365DSCConfigurationBuild -Path .\M365TenantConfig.ps1