Project

PowerBGInfo

Generate support-ready Windows desktop and logon backgrounds from PowerShell data, charts, and topology.

Stars 312
Forks 27
PowerShell Gallery downloads 612,914
Release v2.0.3
Language: C# Updated: 2026-09-02

API Reference

Command

New-BGInfoVariable

Namespace PowerBGInfo
Inputs
None
Outputs
PowerBGInfo.BgInfoVariable

Creates a reusable BGInfo variable backed by a built-in provider.

Remarks

Creates a reusable BGInfo variable backed by a built-in provider.

Examples

Authored help example

EXAMPLE 1


New-BGInfoVariable -Name 'Name' -Provider 'Value'
        

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

New-BGInfoVariable [-Argument <String>] -Name <String> -Provider <Volumes> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Argument String optionalposition: namedpipeline: False
Optional provider argument for filtering/customization.
Name String requiredposition: namedpipeline: False
Name used by -ForEach references.
Provider BgInfoVariableProvider requiredposition: namedpipeline: Falsevalues: 1
Built-in provider used to populate the variable.
Possible values: Volumes

Outputs

PowerBGInfo.BgInfoVariable