API Reference
Class
CmdletImportTlsRptReportSnapshot
Imports TLS-RPT JSON reports into a time-series store.
Inheritance
- PSCmdlet
- CmdletImportTlsRptReportSnapshot
Examples
Ingest TLS-RPT reports from a folder
Import-DDTlsRptReportSnapshot -DomainName example.com -Path .\TlsRpt -StorePath .\Store
Ingest TLS-RPT report attachments from IMAP
Import-DDTlsRptReportSnapshot -DomainName example.com -StorePath .\Store -ImapHost imap.example.com -Credential (Get-Credential) -Mailbox INBOX -SinceUtc (Get-Date).ToUniversalTime().AddDays(-7)
Constructors
public CmdletImportTlsRptReportSnapshot() #Methods
ProcessRecord() #Executes the cmdlet.
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 String DomainName { get; set; } #Parameter(Mandatory = true) ValidateNotNullOrEmpty ValidateDomainNameDomain these TLS-RPT reports belong to (policy domain).
public String Path { get; set; } #Parameter(Mandatory = true, ParameterSetName = "Path", Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true) ValidateNotNullOrEmptyPath to a report file/folder/wildcard.
public String StorePath { get; set; } #Parameter(Mandatory = true) ValidateNotNullOrEmptyRoot directory for snapshot storage.
public String ImapHost { get; set; } #Parameter(Mandatory = true, ParameterSetName = "Imap") ValidateNotNullOrEmptyIMAP host used for mailbox ingestion.
public Int32 ImapPort { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")IMAP port (default 993).
public Boolean ImapUseSsl { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")Use SSL/TLS for IMAP connection (default true).
public PSCredential Credential { get; set; } #Parameter(Mandatory = true, ParameterSetName = "Imap")Credential for IMAP authentication.
public String Mailbox { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")Mailbox folder name (default INBOX).
public String SubjectContains { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")Only scan messages with a subject containing this string.
public Nullable<DateTime> SinceUtc { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")Only fetch messages delivered since this UTC date/time.
public Int32 MaxMessages { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")Maximum number of messages to scan (default 500).
public Int32 MaxAttachmentMb { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")Maximum attachment size to decode in MB (0 for unlimited).
public Boolean OnlyUnseen { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Imap")Only consider unseen messages (default true).
public SwitchParameter NoDeduplicate { get; set; } #Parameter(Mandatory = false)Disable in-run deduplication (by report-id/date-range/org/domain).
public SwitchParameter AsResult { get; set; } #Parameter(Mandatory = false)Return the ingest result wrapper instead of snapshots.
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