Skip to content

Parameters Reference

Invoke-AzureScout Parameters

Core

Parameter Description
-TenantID Target Azure AD / Entra ID tenant ID
-SubscriptionID Limit to one or more specific subscription IDs (comma-separated or array)
-ResourceGroup Limit to one or more specific resource groups
-ManagementGroup Inventory all subscriptions under a management group
-Scope ArmOnly (default), All, or EntraOnly — controls which data domains are inventoried
-OutputFormat All (default), Excel, Json, Markdown (MD), AsciiDoc (Adoc), PowerBI — controls report file types; PowerBI generates flat normalized CSVs in a PowerBI/ subfolder optimized for Power BI / Microsoft Fabric
-Category Filter by resource category: AI, Analytics, Compute, Containers, Databases, Hybrid, Identity, Integration, IoT, Management, Monitor, Networking, Security, Storage, Web — see Category Filtering

Authentication

Parameter Description
-AppId Service principal application (client) ID
-Secret Service principal client secret or certificate password
-CertificatePath Path to .pfx certificate file for SPN authentication
-DeviceLogin Use device code authentication flow (for headless/remote sessions)

See Authentication for detailed examples of each method.

Content Options

Parameter Description
-SecurityCenter Include Microsoft Defender for Cloud data (assessments, alerts, secure score)
-IncludeTags Include resource tags in Excel worksheets
-SkipPolicy Skip Azure Policy compliance collection
-SkipAdvisory Skip Azure Advisor recommendation collection
-SkipVMDetails Skip extra VM detail collection (extensions, boot diagnostics status)
-SkipDiagram Skip network diagram generation
-SkipPermissionCheck Skip the pre-flight permission validation

Output

Parameter Description
-ReportName Custom report filename (default: AzureScout_Report_<timestamp>)
-ReportDir Custom output directory (default: C:\AzureScout\ on Windows, $HOME/AzureScout/ on Linux/Mac)
-Lite Lightweight Excel report — no charts or pivot tables

Diagram

Parameter Description
-DiagramFullEnvironment Include all network components in the draw.io topology diagram

Other

Parameter Description
-AzureEnvironment Target Azure cloud: AzureCloud (default), AzureUSGovernment, AzureChinaCloud, AzureGermanCloud
-Debug Verbose debug output during extraction and processing

Test-AZSCPermissions Parameters

Parameter Description
-TenantID Target tenant ID to validate permissions against
-Scope All (default), ArmOnly, or EntraOnly — controls which permission checks run

Returns a structured object:

$result = Test-AZSCPermissions -TenantID '00000000-...' -Scope All
$result.ArmAccess    # $true / $false
$result.GraphAccess  # $true / $false
$result.Details      # Array of check results with remediation guidance

See Permissions for the full list of required roles and API permissions.