API Reference
Class
CmdletSetExportOptions
Sets global export defaults for DomainDetective reports.
Inheritance
- PSCmdlet
- CmdletSetExportOptions
Constructors
public CmdletSetExportOptions() #Methods
ProcessRecord() #Applies the specified export option changes.
Inherited Methods
public PathInfo CurrentProviderLocation(String providerId) #Returns:
PathInfoInherited from PSCmdlet
Parameters
- providerId String
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public Collection<String> GetResolvedProviderPathFromPSPath(String path, out ProviderInfo provider) #Returns:
Collection<String>Inherited from PSCmdlet
Parameters
- path String
- provider ProviderInfo
public override String GetResourceString(String baseName, String resourceId) #Returns:
StringInherited from Cmdlet
Parameters
- baseName String
- resourceId String
public String GetUnresolvedProviderPathFromPSPath(String path) #Returns:
StringInherited from PSCmdlet
Parameters
- path String
public Object GetVariableValue(String name, Object defaultValue) #Returns:
ObjectInherited from PSCmdlet
Parameters
- name String
public Boolean ShouldContinue(String query, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- query String
- caption String
- hasSecurityImpact Boolean
- yesToAll Boolean
- noToAll Boolean
public Boolean ShouldProcess(String verboseDescription, String verboseWarning, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- verboseDescription String
- verboseWarning String
- caption String
- shouldProcessReason ShouldProcessReason
public Void ThrowTerminatingError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteCommandDetail(String text) #Returns:
VoidInherited from Cmdlet
Parameters
- text String
public Void WriteError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteInformation(InformationRecord informationRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- messageData Object
- tags String[]
public Void WriteObject(Object sendToPipeline) #Returns:
VoidInherited from Cmdlet
Parameters
- sendToPipeline Object
- enumerateCollection Boolean
public Void WriteProgress(ProgressRecord progressRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- progressRecord ProgressRecord
Properties
public Nullable<ReportFormat> DefaultFormat { get; set; } #Parameter(Mandatory = false) ValidateSet(["Html", "Json", "Word", "Excel", "Markdown", "MarkdownHtml"], IgnoreCase = true)Default format for exports.
public String OutputDirectory { get; set; } #Parameter(Mandatory = false)Default output directory for exported reports.
public String ArtifactsDirectory { get; set; } #Parameter(Mandatory = false)Default artifacts directory (for scan.json, metrics.json, progress.jsonl).
public String LogoPath { get; set; } #Parameter(Mandatory = false)Logo path for header branding (optional).
public Nullable<Int32> HeaderLogoSizePx { get; set; } #Parameter(Mandatory = false) ValidateRange(8, 512)Header logo height in pixels (optional).
public String HeaderText { get; set; } #Parameter(Mandatory = false)Header text (optional; shown in Word header if provided).
public String WatermarkText { get; set; } #Parameter(Mandatory = false)Watermark text (optional; applied to sections).
public Nullable<Int32> SummaryColumnCap { get; set; } #Parameter(Mandatory = false) ValidateRange(1, 12)Max status columns in Word executive summary tables.
public String CompanyName { get; set; } #Parameter(Mandatory = false)Company name for custom document properties.
public String CompanyAddress { get; set; } #Parameter(Mandatory = false)Company address for custom document properties.
public String CompanyYear { get; set; } #Parameter(Mandatory = false)Company year for custom document properties.
public String Subject { get; set; } #Parameter(Mandatory = false)Override the report Subject/Description.
public String Keywords { get; set; } #Parameter(Mandatory = false)Override the report Keywords (comma-separated).
public String Creator { get; set; } #Parameter(Mandatory = false)Override the report Creator/Author.
public SwitchParameter OpenInBrowser { get; set; } #Parameter(Mandatory = false) Alias(["OpenReport"])Open reports after generation (HTML in browser, others via shell).
public SwitchParameter Artifacts { get; set; } #Parameter(Mandatory = false)Emit artifacts (scan.json, metrics.json, progress.jsonl) by default.
public SwitchParameter NoArtifacts { get; set; } #Parameter(Mandatory = false)Disable artifact emission by default.
public SwitchParameter Reset { get; set; } #Parameter(Mandatory = false)Reset export defaults to built-in values.
public Nullable<NarrativePlacement> NarrativePlacement { get; set; } #Parameter(Mandatory = false)Default narrative placement for reports.
Inherited Properties
public PSEventManager Events { get; } #Inherited from PSCmdlet
public PSHost Host { get; } #Inherited from PSCmdlet
public CommandInvocationIntrinsics InvokeCommand { get; } #Inherited from PSCmdlet
public ProviderIntrinsics InvokeProvider { get; } #Inherited from PSCmdlet
public JobManager JobManager { get; } #Inherited from PSCmdlet
public JobRepository JobRepository { get; } #Inherited from PSCmdlet
public InvocationInfo MyInvocation { get; } #Inherited from PSCmdlet
public PagingParameters PagingParameters { get; } #Inherited from PSCmdlet
public String ParameterSetName { get; } #Inherited from PSCmdlet
public SessionState SessionState { get; } #Inherited from PSCmdlet
public ICommandRuntime CommandRuntime { get; set; } #Inherited from Cmdlet
public Boolean Stopping { get; } #Inherited from Cmdlet
public CommandOrigin CommandOrigin { get; } #Inherited from InternalCommand