Svrooij.WinTuner.CmdLets.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Svrooij.WinTuner.CmdLets</name>
    </assembly>
    <members>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet">
            <summary>
            Base class for all cmdlets that need to connect to Graph.
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.UseManagedIdentity">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.UseDefaultAzureCredential">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.Token">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.NoBroker">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.Username">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.TenantId">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.ClientId">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.ClientSecret">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.Scopes">
            <summary>
            
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.BaseIntuneCmdlet.DefaultScopes">
            <summary>
            
            </summary>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.DeployWtMsStoreApp">
            <summary>
            <para type="synopsis">Create a MsStore app in Intune</para>
            <para type="description">Use this command to create an Microsoft Store app in Microsoft Intune</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/Deploy-WtMsStoreApp">Documentation</para>
            </summary>
            <example>
            <para type="description">Add Firefox to Intune, using interactive authentication</para>
            <code>Deploy-WtMsStoreApp -PackageId 9NZVDKPMR9RD -Username admin@myofficetenant.onmicrosoft.com</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtMsStoreApp.PackageId">
            <summary>
            <para type="description">The package id to upload to Intune.</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtMsStoreApp.SearchQuery">
            <summary>
            <para type="description">Name of the app to look for, first match will be created.</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.DeployWtMsStoreApp.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App">
            <summary>
            <para type="synopsis">Create a Win32Lob app in Intune</para>
            <para type="description">Use this command to upload an intunewin package to Microsoft Intune as a new Win32LobApp.</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/Deploy-WtWin32App">Documentation</para>
            </summary>
            <example>
            <para type="description">Upload a pre-packaged application, from just it's folder, using interactive authentication</para>
            <code>Deploy-WtWin32App -PackageFolder C:\Tools\packages\JanDeDobbeleer.OhMyPosh\19.5.2 -Username admin@myofficetenant.onmicrosoft.com</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.App">
            <summary>
            <para type="description">The Win32LobApp configuration you want to create</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.IntuneWinFile">
            <summary>
            <para type="description">The .intunewin file that should be added to this app</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.LogoPath">
            <summary>
            <para type="description">Load the logo from file (optional)</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.PackageId">
            <summary>
            <para type="description">The package id to upload to Intune.</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.Version">
            <summary>
            <para type="description">The version to upload to Intune</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.RootPackageFolder">
            <summary>
            <para type="description">The Root folder where all the package live in.</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.PackageFolder">
            <summary>
            <para type="description">The folder where the package is</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.OverrideAppName">
            <summary>
            Override the name of the app in Intune
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.GraphId">
            <summary>
            <para type="description">The graph id of the app to supersede</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.DeployWtWin32App.SupersedeApp(Microsoft.Extensions.Logging.ILogger,Microsoft.Graph.Beta.GraphServiceClient,System.String,System.String,System.Threading.CancellationToken)">
            <summary>
            Supersede an app.
            </summary>
            <remarks>
            1. Load the old app
            2. Update relationships of the new app to supersede the old app
            3. Copy categories from the old app to the new app
            4. Copy assignments from the old app to the new app
            5. Remove assignments from the old app
            </remarks>
            <param name="logger"></param>
            <param name="graphServiceClient"></param>
            <param name="newAppId"></param>
            <param name="oldAppId"></param>
            <param name="cancellationToken"></param>
            <returns></returns>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.GetWtWin32Apps">
            <summary>
            <para type="synopsis">Get all apps from Intune packaged by WinTuner</para>
            <para type="description">Load apps from Tenant and filter based on Update Availabe, pipe to `New-IntuneWinPackage`</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/Get-WtWin32Apps">Documentation</para>
            </summary>
            <example>
            <para type="description">Get all apps that have updates, using interactive authentication</para>
            <code>Get-WtWin32Apps -Update $true -Username admin@myofficetenant.onmicrosoft.com</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.GetWtWin32Apps.Update">
            <summary>
            <para type="description">Filter based on UpdateAvailable</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.GetWtWin32Apps.Superseded">
            <summary>
            <para type="description">Filter based on SupersedingAppCount</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.GetWtWin32Apps.Superseding">
            <summary>
            <para type="description">Filter based on SupersedingAppCount</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.GetWtWin32Apps.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.NewIntuneWinPackage">
            <summary>
            <para type="synopsis">Create a new IntuneWin package</para>
            <para type="description">This is a re-implementation of the IntuneWinAppUtil.exe tool, it's not feature complete use at your own risk.</para>
            <para type="link" uri="https://wintuner.app/docs/related/content-prep-tool">Documentation</para>
            </summary>
            <example>
            <para type="description">Package all files in C:\Temp\Source, with setup file ..\setup.exe to the specified folder</para>
            <code>New-IntuneWinPackage -SourcePath C:\Temp\Source -SetupFile C:\Temp\Source\setup.exe -DestinationPath C:\Temp\Destination</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewIntuneWinPackage.SourcePath">
            <summary>
            <para type="description">Directory containing all the installation files</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewIntuneWinPackage.SetupFile">
            <summary>
            <para type="description">The main setupfile in the source directory</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewIntuneWinPackage.DestinationPath">
            <summary>
            <para type="description">Destination folder</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.NewIntuneWinPackage.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage">
            <summary>
            <para type="synopsis">Create intunewin file from Winget installer</para>
            <para type="description">Downloads the installer for the package and creates an `.intunewin` file for uploading in Intune.</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/New-WtWingetPackage">Documentation</para>
            </summary>
            <example>
            <para type="description">Package all files in C:\Temp\Source, with setup file ..\setup.exe to the specified folder</para>
            <code>New-WtWingetPackage -PackageId JanDeDobbeleer.OhMyPosh -PackageFolder C:\Tools\Packages</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.PackageId">
            <summary>
            Package id to download
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.PackageFolder">
            <summary>
            The folder to store the package in
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.Version">
            <summary>
            The version to download (optional)
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.TempFolder">
            <summary>
            The folder to store temporary files in
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.Architecture">
            <summary>
            Pick this architecture
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.InstallerContext">
            <summary>
            The installer context
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.PackageScript">
            <summary>
            Package as script
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.Locale">
            <summary>
            Desired locale
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.InstallerArguments">
            <summary>
            Override the installer arguments
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.NewWtWingetPackage.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.RemoveWtWin32App">
            <summary>
            <para type="synopsis">Remove an app from Intune</para>
            <para type="description">Will remove the relationships (if any) first and then remove the app.</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/Remove-WtWin32App">Documentation</para>
            </summary>
            <example>
            <para type="description">Delete a single app by ID with interactive authentication</para>
            <code>Remove-WtWin32App -AppId "1450c17d-aee5-4bef-acf9-9e0107d340f2" -Username admin@myofficetenant.onmicrosoft.com</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.RemoveWtWin32App.AppId">
            <summary>
            <para type="description">Id of the app in Intune</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.RemoveWtWin32App.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.SearchWtWinGetPackage">
            <summary>
            <para type="synopsis">Search for packages in winget</para>
            <para type="description">Search for WinGet packages, but faster</para>
            </summary>
            <example>
            <para type="description">Search for 'fire', did I tell you it's fast?</para>
            <code>Search-WtWinGetPackage fire</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.SearchWtWinGetPackage.PackageId">
            <summary>
            
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.SearchWtWinGetPackage.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc />
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin">
            <summary>
            <para type="synopsis">Test if a package will install</para>
            <para type="description">Test if a package will install on the Windows Sandbox</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/Test-WtIntuneWin">Documentation</para>
            </summary>
            <example>
            <para type="description">Test a packaged installer in sandbox</para>
            <code>Test-WtIntuneWin -PackageFolder D:\packages\JanDeDobbeleer.OhMyPosh\22.0.3</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.PackageId">
            <summary>
            <para type="description">The package id to upload to Intune.</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.Version">
            <summary>
            <para type="description">The version to upload to Intune</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.RootPackageFolder">
            <summary>
            <para type="description">The Root folder where all the package live in.</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.PackageFolder">
            <summary>
            <para type="description">The folder where the package is</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.IntuneWinFile">
            <summary>
            <para type="description">The IntuneWin file to test</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.InstallerFilename">
            <summary>
            <para type="description">The installer filename (if not set correctly inside the intunewin)</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.InstallerArguments">
            <summary>
            <para type="description">The installer arguments (if you want it to execute silently)</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.Clean">
            <summary>
            <para type="description">Clean the test files after run</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.Sleep">
            <summary>
            <para type="description">Sleep for x seconds before closing</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.TestWtIntuneWin.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.TestWtSetupFile">
            <summary>
            <para type="synopsis">Test your silent install switches</para>
            <para type="description">Test if a setup will install on the Windows Sandbox</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/Test-WtSetupFile">Documentation</para>
            </summary>
            <example>
            <para type="description">Test any installer in sandbox</para>
            <code>Test-WtSetupFile -SetupFile D:\packages\xyz.exe -Installer "all your arguments"</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtSetupFile.InstallerArguments">
            <summary>
            <para type="description">Override the installer arguments</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtSetupFile.SetupFile">
            <summary>
            <para type="description">The absolute path to your setup file</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.TestWtSetupFile.Sleep">
            <summary>
            <para type="description">Sleep for x seconds before closing</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.TestWtSetupFile.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.UnprotectIntuneWinPackage">
            <summary>
            <para type="synopsis">Decrypt an IntuneWin package</para>
            <para type="description">Decrypt IntuneWin files, based on this post https://svrooij.io/2023/10/09/decrypting-intunewin-files/</para>
            <para type="link" uri="https://wintuner.app/docs/related/content-prep-tool#unlock-intunewinpackage">Documentation</para>
            </summary>
            <example>
            <code>Unprotect-IntuneWinPackage -SourceFile C:\Temp\Source\MyApp.intunewin -DestinationPath C:\Temp\Destination</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UnprotectIntuneWinPackage.SourceFile">
            <summary>
            <para type="description">The location of the .intunewin file</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UnprotectIntuneWinPackage.DestinationPath">
            <summary>
            <para type="description">Destination folder</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.UnprotectIntuneWinPackage.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp">
            <summary>
            <para type="synopsis">Update an app in Intune</para>
            <para type="description">Update the assignments and/or categories for an app in Intune.</para>
            <para type="link" uri="https://wintuner.app/docs/wintuner-powershell/Update-WtIntuneApp">Documentation</para>
            </summary>
            <example>
            <para type="description">Update the categories of an app and make it available for all users</para>
            <code>Update-WtIntuneApp -AppId "1450c17d-aee5-4bef-acf9-9e0107d340f2" -UseDefaultCredentials -Categories "Productivity","Business" -AvailableFor "AllUsers" -EnableAutoUpdate $true</code>
            </example>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp.AppId">
            <summary>
            <para type="description">Id of the app in Intune</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp.Categories">
            <summary>
            <para type="description">Categories to add to the app</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp.AvailableFor">
            <summary>
            <para type="description">Groups that the app should available for, Group Object ID or 'AllUsers'/'AllDevices'</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp.RequiredFor">
            <summary>
            <para type="description">Groups that the app is required for, Group Object ID or 'AllUsers'/'AllDevices'</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp.UninstallFor">
            <summary>
            <para type="description">Groups that the app should be uninstalled for, Group Object ID or 'AllUsers'/'AllDevices'</para>
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp.EnableAutoUpdate">
            <summary>
            <para type="description">Enable auto update for the app</para>
            </summary>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Commands.UpdateWtIntuneApp.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Models.WtWin32App">
            <summary>
            Deployed Win32App in Intune
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Models.WtWin32App.LatestVersion">
            <summary>
            Latest version of the app according to the winget repository
            </summary>
        </member>
        <member name="P:Svrooij.WinTuner.CmdLets.Models.WtWin32App.IsUpdateAvailable">
            <summary>
            Is there an update available for this app
            </summary>
        </member>
        <member name="T:Svrooij.WinTuner.CmdLets.Startup">
            <inheritdoc/>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Startup.ConfigureServices(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <inheritdoc/>
        </member>
        <member name="M:Svrooij.WinTuner.CmdLets.Startup.ConfigurePowerShellLogging">
            <inheritdoc/>
        </member>
    </members>
</doc>