en-US/about_Get-EntraZTAssess.help.txt

TOPIC
    about_Get-EntraZTAssess

SHORT DESCRIPTION
    Read-only Microsoft Entra ID and Intune Zero Trust assessment toolkit.

LONG DESCRIPTION
    The Get-EntraZTAssess module collects Microsoft Entra ID and Intune
    configuration through read-only Microsoft Graph scopes, persists redacted
    evidence to a local engagement run folder, evaluates the tenant against a
    declarative Zero Trust check library, scores maturity and risk separately,
    and exports local consultant reporting artifacts.

    Phase 5 delivery-ready reporting is disk-only. Export-ZTAssessReport reads a
    completed run folder and writes these files beneath <RunPath>/Reports:
    ExecutiveReport.html, TechnicalReport.html, RiskRegister.json,
    RiskRegister.csv, and RemediationRoadmap.json. Use -RedactUserIdentifiers
    when generated reports need client-safe user identifier redaction; source
    findings, snapshots, scores, and manifests remain unchanged. The report
    exporter does not connect to Microsoft Graph and does not implement PDF,
    Excel workbook, or dashboard outputs.

COMMANDS
    Connect-ZTAssessment
    Disconnect-ZTAssessment
    Export-ZTAssessReport
    Get-ZTAssessFinding
    Get-ZTAssessModuleCatalog
    Get-ZTAssessRequiredPermission
    Get-ZTAssessScore
    Invoke-ZTAssessment
    New-ZTAssessEngagement

EXAMPLES
    Connect-ZTAssessment -Modules Identity, ConditionalAccess, PrivilegedAccess, Devices
    $engagement = New-ZTAssessEngagement -CustomerName 'Contoso Ltd' -Reference 'ENG-2026-042' -OutputPath ~/Assessments
    $run = Invoke-ZTAssessment -EngagementPath $engagement.EngagementPath
    Export-ZTAssessReport -RunPath $run.RunPath
    Export-ZTAssessReport -RunPath $run.RunPath -RedactUserIdentifiers

    Get-ZTAssessFinding -RunPath $run.RunPath -Status Fail -Severity Critical,High
    Get-ZTAssessScore -RunPath $run.RunPath

NOTES
    This module requires PowerShell 7.0 or later. Graph-facing collection is
    read-only; report export is local filesystem only. Risk-register and
    remediation-roadmap rows include Fail and Partial findings only, with SLA
    values sourced from source/Settings/settings.psd1 RemediationSlaDays.

SEE ALSO
    Connect-ZTAssessment
    Invoke-ZTAssessment
    Export-ZTAssessReport
    Get-ZTAssessFinding
    Get-ZTAssessScore