en-US/endpointmanager.wingetbridge.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-WingetManifest</command:name> <maml:description> <maml:para>Downloads the package manifest (includes package details), and returns it as an object</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>WingetManifest</command:noun> </command:details> <maml:description> <maml:para>Downloads the package manifest (includes package details), and returns it as an object. (Always requires internet connection)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WingetManifest</maml:name> <command:parameter required="false" position="named" > <maml:name>Package</maml:name> <command:parameterValue required="true">WingetPackage</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>PackageVersion</maml:name> <command:parameterValue required="true">PackageVersion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" > <maml:name>Package</maml:name> <maml:description> <maml:para>Specify a Package from the results of [Start-WingetSearch]</maml:para> </maml:description> </command:parameter> <command:parameter required="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" > <maml:name>PackageVersion</maml:name> <maml:description> <maml:para>Specify a specific version given by the results of [(Start-WingetSearch).Versions]</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> <maml:description> <maml:para>Default Webproxy will be used by default, but can be disabled by using [-UseDefaultWebProxy:$false]</maml:para> </maml:description> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code></dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Save-WingetBridgeAppIcon</command:name> <maml:description> <maml:para>Saves the default application icon that is contained in the specified executable.</maml:para> </maml:description> <command:verb>Save</command:verb> <command:noun>WingetBridgeAppIcon</command:noun> </command:details> <maml:description> <maml:para>Saves the default application icon (multi-resolution format up to 256x256px) that is contained in the specified [-SourceFile], to the specified [-TargetIconFile].</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-WingetBridgeAppIcon</maml:name> <command:parameter required="true" position="named" > <maml:name>SourceFile</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TargetIconFile</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>ValidateOnly</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named" > <maml:name>SourceFile</maml:name> <maml:description> <maml:para>An icon (*.ico) or executable (*.exe) containing icons you want to copy or extract.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TargetIconFile</maml:name> <maml:description> <maml:para>Specify the target filename. (Directory must exist, if specified a full path with the filename)</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>ValidateOnly</maml:name> <maml:description> <maml:para>Returns available resolutions within the specified [-SourceFile]. (When using this switch, the [-TargetIconFile] wont't be saved)</maml:para> </maml:description> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Save-WingetBridgeAppIcon -SourceFile "C:\Windows\Explorer.exe" -TargetIconFile "explorer.ico"</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-WingetInstallerDownload</command:name> <maml:description> <maml:para>Downloads a specified package installer.</maml:para> </maml:description> <command:verb>Start</command:verb> <command:noun>WingetInstallerDownload</command:noun> </command:details> <maml:description> <maml:para>Downloads a specified package installer When using this cmdlet you need to confirm that the author of this module is not responsible for, nor does it grant any licenses to, third-party packages. Even the author did it's best to develop a stable build, he provides his work \"as-it-is\" and should not be used in a production environment without testing it. Before you install (or deploy) any packages, you need to check and agree it's license agreements on your own. WingetBridge uses the official Winget-Repository to get download informations. However, Microsoft is also not responsible for, nor does it grant any licences to, third-party packages. To accept the agreement, use this cmdlet together with [-AcceptAgreements]</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-WingetInstallerDownload</maml:name> <command:parameter required="true" position="named" > <maml:name>PackageInstaller</maml:name> <command:parameterValue required="true">Installer</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>CustomUserAgent</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TargetDirectory</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Timeout</maml:name> <command:parameterValue required="true">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>AcceptAgreements</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named" > <maml:name>AcceptAgreements</maml:name> <maml:description> <maml:para>By using this paramenter, you confirm the agreements. Please execute without -AcceptAgreements to show the agreements and get more details.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>CustomUserAgent</maml:name> <maml:description> <maml:para>Specify a custom User-Agent to be included in the request header. (e.g. "Microsoft-Delivery-Optimization/10.0")</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites existing downloads. (Usually package installers are SHA256 verified, and get downloaded again only on hash mismatch.)</maml:para> </maml:description> </command:parameter> <command:parameter required="true" pipelineInput="true (ByValue, ByPropertyName)" position="named" > <maml:name>PackageInstaller</maml:name> <maml:description> <maml:para>Specify a installer provided in the package details. Use [Get-WingetManifest] to get all available installers for a package.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TargetDirectory</maml:name> <maml:description> <maml:para>Specify a target Directory (must exist), otherwise the download get saved in the current directory.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify a timeout in seconds. (If not specified, the default value is 60 seconds)</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> <maml:description> <maml:para>Default Webproxy will be used by default, but can be disabled by using [-UseDefaultWebProxy:$false]</maml:para> </maml:description> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>(Start-WingetSearch -SearchByMoniker "vlc" | Get-WingetManifest).Installers | Start-WingetInstallerDownload</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-WingetSearch</command:name> <maml:description> <maml:para>Searches packages in the winget-repository without using the winget-cli.</maml:para> </maml:description> <command:verb>Start</command:verb> <command:noun>WingetSearch</command:noun> </command:details> <maml:description> <maml:para>Searches packages in the winget-repository without using the winget-cli. Requires internet connection if cache is not up to date.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-WingetSearch</maml:name> <command:parameter required="false" position="named" > <maml:name>MaxCacheAge</maml:name> <command:parameterValue required="true">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchById</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchByMoniker</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchByName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchByPublisherId</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named" > <maml:name>MaxCacheAge</maml:name> <maml:description> <maml:para>Maximum Cache Age in minutes. (Default value is 1440 minutes (or 1 day)) If the given value (in minutes) is lower than the time between last synchronization, it will automatically update the cache.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchById</maml:name> <maml:description> <maml:para>Filter results by Package-Id</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchByMoniker</maml:name> <maml:description> <maml:para>Filter results by Moniker</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchByName</maml:name> <maml:description> <maml:para>Filter results by Name</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>SearchByPublisherId</maml:name> <maml:description> <maml:para>Filter results by Publisher-Id</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> <maml:description> <maml:para>Default Webproxy will be used by default, but can be disabled by using [-UseDefaultWebProxy:$false]</maml:para> </maml:description> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Start-WingetSearch -SearchByMoniker "vlc" -MaxCacheAge 15</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-WingetBridgeCache</command:name> <maml:description> <maml:para>Updates the cache (local database) for WingetBridge.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>WingetBridgeCache</command:noun> </command:details> <maml:description> <maml:para>Updates the cache (local database) for WingetBridge. Requires internet connection if cache is not up to date (or does not exist yet). It is optional to update the cache before using the cmdlet "Start-WingetSearch", as it updates the cache automatically if required.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-WingetBridgeCache</maml:name> <command:parameter required="false" position="named" > <maml:name>MaxCacheAge</maml:name> <command:parameterValue required="true">Nullable`1</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Force</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named" > <maml:name>Force</maml:name> <maml:description> <maml:para>Resets local database (cache) before synchronization and forces an initial synchronization.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>MaxCacheAge</maml:name> <maml:description> <maml:para>Maximum Cache Age in minutes. (Default value is 1440 minutes (or 1 day)) If the given value (in minutes) is lower than the time between last synchronization, it will automatically update the cache.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>UseDefaultWebProxy</maml:name> <maml:description> <maml:para>Default Webproxy will be used by default, but can be disabled by using [-UseDefaultWebProxy:$false]</maml:para> </maml:description> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Update-WingetBridgeCache -Force</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |