PSDODownloader

0.1.0

DODownloader.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-DORequests</command:name>

      <command:verb>Get</command:verb>

      <command:noun>DORequests</command:noun>

      <maml:description>

        <maml:para>Get Delivery Optimization downloads.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The `Get-DORequests` cmdlet gets Delivery Optimization downloads present on the device, including cached downloads. It returns downloads and their properties from DODownloadProperty (https://learn.microsoft.com/en-us/windows/win32/api/deliveryoptimization/ne-deliveryoptimization-dodownloadproperty). Some properties may be null and produce a verbose log.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-DORequests</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Uri</maml:name>

          <maml:description>

            <maml:para>The remote URI path of the resource to download.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue>

          <dev:type>

            <maml:name>Uri</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Uri</maml:name>

        <maml:description>

          <maml:para>The remote URI path of the resource to download.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue>

        <dev:type>

          <maml:name>Uri</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>DODownloadProperties</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>This cmdlet returns downloads and their properties from DODownloadProperty (https://learn.microsoft.com/en-us/windows/win32/api/deliveryoptimization/ne-deliveryoptimization-dodownloadproperty).</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert />

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Get-DORequests

Id                                 : 4a5ada83-a9a6-4cca-9404-a58414d269a2

Uri                                : http://dl.delivery.mp.microsoft.com/filestreamingservice/files/52fa8751-747d-479d-8f22-e32730cc0eb1

ContentId                          : 

DisplayName                        : WU Client Download

LocalPath                          : 

HttpCustomHeaders                  : 

CostPolicy                         : 0

SecurityFlags                      : 0

CallbackFreqPercent                : 

CallbackFreqSeconds                : 1

NoProgressTimeoutSeconds           : 1800

ForegroundPriority                 : True

BlockingMode                       : False

SecurityContext                    : 

NetworkToken                       : 

CorrelationVector                  : qgTBxRZBOk2hE4E7.10

DecryptionInfo                     : 

IntegrityCheckInfo                 : 

IntegrityCheckMandatory            : False

TotalSizeBytes                     : 25006511

DisallowOnCellular                 : False

HttpCustomAuthHeaders              : 

HttpAllowSecureToNonSecureRedirect : 

NonVolatile                        : False</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- Example 2 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Get-DORequests -Uri http://b.c2r.ts.cdn.office.net/pr/492350f6-3a01-4f97-b9c0-c7c6ddf67d60/Office/Data/16.0.17531.20152/i640.c2rx

Id                                 : 50527b41-ca8e-45c5-9aa2-95fd52d20edb

Uri                                : http://b.c2r.ts.cdn.office.net/pr/492350f6-3a01-4f97-b9c0-c7c6ddf67d60/Office/Data/16.0.17531.20152/i640.c2rx

ContentId                          : 

DisplayName                        : Microsoft Office Click-to-Run

LocalPath                          : 

HttpCustomHeaders                  : 

CostPolicy                         : 0

SecurityFlags                      : 0

CallbackFreqPercent                : 

CallbackFreqSeconds                : 1

NoProgressTimeoutSeconds           : 1800

ForegroundPriority                 : True

BlockingMode                       : False

SecurityContext                    : 

NetworkToken                       : 

CorrelationVector                  : /ovgbBM6bkiHF+0p.12

DecryptionInfo                     : 

IntegrityCheckInfo                 : 

IntegrityCheckMandatory            : False

TotalSizeBytes                     : 70073445

DisallowOnCellular                 : False

HttpCustomAuthHeaders              : 

HttpAllowSecureToNonSecureRedirect : 

NonVolatile                        : False</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Invoke-DORequest</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

    </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Invoke-DORequest</command:name>

      <command:verb>Invoke</command:verb>

      <command:noun>DORequest</command:noun>

      <maml:description>

        <maml:para>Download a file using the Delivery Optimization service.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The `Invoke-DORequest` cmdlet requests a file download from the Delivery Optimization service. The download can be streamed and deleted after completion, or written to a provided path. Byte ranges can also be requested, instead of the whole file. No results are returned.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-DORequest</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>OutFile</maml:name>

          <maml:description>

            <maml:para>The local path name to save the download file.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Ranges</maml:name>

          <maml:description>

            <maml:para>Pairs of byte ranges (https://learn.microsoft.com/en-us/windows/win32/api/deliveryoptimization/ns-deliveryoptimization-do_download_range)to download from a file. Formatted as a flat array.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue>

          <dev:type>

            <maml:name>Int32[]</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Uri</maml:name>

          <maml:description>

            <maml:para>The remote URI path of the resource to download.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue>

          <dev:type>

            <maml:name>Uri</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Caller</maml:name>

          <maml:description>

            <maml:para>The caller display name, also known as `PredefinedCallerApplication`.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>ContentId</maml:name>

          <maml:description>

            <maml:para>The unique content ID of the resource to download.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>OutFile</maml:name>

        <maml:description>

          <maml:para>The local path name to save the download file.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Ranges</maml:name>

        <maml:description>

          <maml:para>Pairs of byte ranges (https://learn.microsoft.com/en-us/windows/win32/api/deliveryoptimization/ns-deliveryoptimization-do_download_range)to download from a file. Formatted as a flat array.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue>

        <dev:type>

          <maml:name>Int32[]</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Uri</maml:name>

        <maml:description>

          <maml:para>The remote URI path of the resource to download.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue>

        <dev:type>

          <maml:name>Uri</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Caller</maml:name>

        <maml:description>

          <maml:para>The caller display name, also known as `PredefinedCallerApplication`.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>ContentId</maml:name>

        <maml:description>

          <maml:para>The unique content ID of the resource to download.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>None &lt;!-- markdownlint-disable MD024 --&gt;</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert />

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Invoke-DORequest -Uri http://dl.delivery.mp.microsoft.com/filestreamingservice/files/52fa8751-747d-479d-8f22-e32730cc0eb1</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- Example 2 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Invoke-DORequest -Uri http://dl.delivery.mp.microsoft.com/filestreamingservice/files/52fa8751-747d-479d-8f22-e32730cc0eb1 -OutFile download.exe</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- Example 3 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Invoke-DORequest -Uri http://dl.delivery.mp.microsoft.com/filestreamingservice/files/52fa8751-747d-479d-8f22-e32730cc0eb1 -Ranges 10,65536,131072,65536</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Get-DORequests</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>