Export-ADXAdmxCatalog

Namespace ADPlayground.PowerShell

Outputs

System.String

Exports the typed ADMX catalog to a JSON file suitable for static explorer consumers.

Examples

Authored help example

Example 1


Export-ADXAdmxCatalog -Path '.\admx-catalog.json'

Example 2


Export-ADXAdmxCatalog -AdmxDirectory 'C:\Windows\PolicyDefinitions' -Language 'en-US' -Path '.\admx-catalog.json' -Compress

Example 3


Export-ADXAdmxCatalog -AdmxDirectory 'C:\Windows\PolicyDefinitions' -Path '.\site-data' -SplitBySource

Example 4


Export-ADXAdmxCatalog -AdmxDirectory 'C:\Windows\PolicyDefinitions' -Path '.\site-data' -SplitBySource -BundleMode Full

Example 5


Export-ADXAdmxCatalog -AdmxDirectory 'C:\Windows\PolicyDefinitions' -Path '.\site-data' -SplitBySource -SourcePackageName 'Microsoft Windows 11 25H2' -SourcePackageVersion '3.0'

Example 6


Export-ADXAdmxCatalog -AdmxDirectory 'C:\Windows\PolicyDefinitions' -Path '.\site-data' -SplitBySource -SourcePackageProvider Windows

Example 7


Export-ADXAdmxCatalog -Path '.\site-data' -SplitBySource -SourcePackageCatalogProvider Edge

Example 8


Export-ADXAdmxCatalog -Path '.\site-data' -SplitBySource -SourcePackageCatalogProviderName 'Contoso Browser'

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Export-ADXAdmxCatalog -Path <string> [-AdmxDirectory <string>] [-BundleMode <Full|Website>] [-Compress] [-Domain <string>] [-Language <string>] [-SourcePackageCacheRoot <string>] [-SourcePackageCatalogProvider <Edge>] [-SourcePackageCatalogProviderName <string>] [-SourcePackageDirectory <string>] [-SourcePackageEdgeChannel <Stable|Beta|Dev|Canary>] [-SourcePackageId <string>] [-SourcePackageName <string>] [-SourcePackageProvider <Edge>] [-SourcePackagePublishedDate <string>] [-SourcePackageUrl <string>] [-SourcePackageVersion <string>] [-SplitBySource] [<CommonParameters>]

Parameters

Path string requiredposition: 0pipeline: false: Destination JSON path or bundle directory when SplitBySource is set.
AdmxDirectory string optionalposition: namedpipeline: false: Optional explicit PolicyDefinitions path.
BundleMode AdmxExplorerBundleMode optionalposition: namedpipeline: falsevalues: 2: Payload shaping mode used when SplitBySource is set. Possible values: Full, Website; Possible values: Full, Website
Compress SwitchParameter optionalposition: namedpipeline: false: Writes compact JSON instead of indented JSON.
Domain string optionalposition: namedpipeline: false: Optional domain name to prefer Central Store discovery when AdmxDirectory is omitted.
Language string optionalposition: namedpipeline: false: Preferred ADML language (for example, en-US).
SourcePackageCacheRoot string optionalposition: namedpipeline: false: Optional provider cache catalog root used with SourcePackageCatalogProvider.
SourcePackageCatalogProvider AdmxProvider optionalposition: namedpipeline: falsevalues: 29: Optional provider cache catalog entry used as both source directory and package metadata. Possible values: Edge, Windows, Office, Notepad, Chrome, Firefox, Clipchamp, SecurityAdmx, Zoom, Winget, AdobeAcrobat, AdobeReader, Brave, FSLogix, OneDrive, VisualStudio, VsCode, RemoteDesktopManager, DellCommandUpdate, PsAppDeployToolkit, WingetAutoUpdate, Teams, Slack, CitrixWorkspaceApp, Mdop, OneDriveOnline, PowerShell, PowerToys, WindowsTerminal; Possible values: Edge, Windows, Office, Notepad, Chrome, Firefox, Clipchamp, SecurityAdmx, Zoom, Winget, AdobeAcrobat, AdobeReader, Brave, FSLogix, OneDrive, VisualStudio, VsCode, RemoteDesktopManager, DellCommandUpdate, PsAppDeployToolkit, WingetAutoUpdate, Teams, Slack, CitrixWorkspaceApp, Mdop, OneDriveOnline, PowerShell, PowerToys, WindowsTerminal
SourcePackageCatalogProviderName string optionalposition: namedpipeline: false: Optional provider cache catalog entry name used as both source directory and package metadata, including custom provider names.
SourcePackageDirectory string optionalposition: namedpipeline: false: Directory whose package-level source group should receive the supplied source package metadata.
SourcePackageEdgeChannel AdmxEdgeChannel optionalposition: namedpipeline: falsevalues: 4: Microsoft Edge channel used when SourcePackageProvider is . Possible values: Stable, Beta, Dev, Canary; Possible values: Stable, Beta, Dev, Canary
SourcePackageId string optionalposition: namedpipeline: false: Stable package identifier to use for the generated package-level source group.
SourcePackageName string optionalposition: namedpipeline: false: Display label to use for the generated package-level source group.
SourcePackageProvider AdmxProvider optionalposition: namedpipeline: falsevalues: 29: Optional built-in provider used to discover package metadata for the generated source package. Possible values: Edge, Windows, Office, Notepad, Chrome, Firefox, Clipchamp, SecurityAdmx, Zoom, Winget, AdobeAcrobat, AdobeReader, Brave, FSLogix, OneDrive, VisualStudio, VsCode, RemoteDesktopManager, DellCommandUpdate, PsAppDeployToolkit, WingetAutoUpdate, Teams, Slack, CitrixWorkspaceApp, Mdop, OneDriveOnline, PowerShell, PowerToys, WindowsTerminal; Possible values: Edge, Windows, Office, Notepad, Chrome, Firefox, Clipchamp, SecurityAdmx, Zoom, Winget, AdobeAcrobat, AdobeReader, Brave, FSLogix, OneDrive, VisualStudio, VsCode, RemoteDesktopManager, DellCommandUpdate, PsAppDeployToolkit, WingetAutoUpdate, Teams, Slack, CitrixWorkspaceApp, Mdop, OneDriveOnline, PowerShell, PowerToys, WindowsTerminal
SourcePackagePublishedDate string optionalposition: namedpipeline: false: Release or publish date to attach to the generated package-level source group.
SourcePackageUrl string optionalposition: namedpipeline: false: Upstream source URL to attach to the generated package-level source group.
SourcePackageVersion string optionalposition: namedpipeline: false: Version to attach to the generated package-level source group.
SplitBySource SwitchParameter optionalposition: namedpipeline: false: Writes a split bundle with manifest and per-source payload files instead of a single JSON file.

Outputs

System.String