Azs.Syndication.Admin

0.1.140

Export.psm1-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>Export-AzsMarketplaceItem</command:name>
      <command:verb>Export</command:verb>
      <command:noun>AzsMarketplaceItem</command:noun>
      <maml:description>
        <maml:para>Export-AzsMarketplaceItem command helps you download the marketplace items from the Azure cloud and store them on a local disk or a file share.</maml:para>
      </maml:description>
    </command:details>
 
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Export-AzsMarketplaceItem</maml:name>
 
        <command:parameter required="true" globbing="false" pipelineinput="true (ByValue)" position="1">
          <maml:name>ProductId</maml:name>
          <command:parameterValue required="true">String[]</command:parameterValue>
        </command:parameter>
 
        <command:parameter required="true" globbing="false" pipelineinput="false" position="2">
          <maml:name>RepositoryDir</maml:name>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="3">
          <maml:name>JournalDir</maml:name>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="named">
          <maml:name>IgnoreDependencies</maml:name>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="named">
          <maml:name>AcceptLegalTerms</maml:name>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="4">
          <maml:name>From</maml:name>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="5">
          <maml:name>UpTo</maml:name>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="6">
          <maml:name>SleepInterval</maml:name>
          <command:parameterValue required="true">Int32</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
 
    <maml:description>
      <maml:para>Export-AzsMarketplaceItem command helps you download the marketplace items, such as VM images, add-on RPs, and vice versa from the Azure cloud and store them on a local disk or a file share. Then those items can be brought onto a disconnected environment, or allow to bypass the common download problems for the connected environments.</maml:para>
      <maml:para>The script requires an active Azure PowerShell session, and you should have read access to the subscription containing the &quot;registration&quot; resource (Microsoft.AzureStack/registrations) for your stamp.</maml:para>
      <maml:para>For more information, see the &quot;Register Azure Stack with Azure&quot; article: https://docs.microsoft.com/en-us/azure-stack/operator/azure-stack-registration</maml:para>
    </maml:description>
 
    <command:parameters>
      <command:parameter required="true" globbing="false" pipelineinput="true (ByValue)" position="1">
        <maml:name>ProductId</maml:name>
        <command:parameterValue required="true">String[]</command:parameterValue>
        <maml:description>
          <maml:para>The list of the products to export.</maml:para>
        </maml:description>
      </command:parameter>
 
      <command:parameter required="true" globbing="false" pipelineinput="false" position="2">
        <maml:name>RepositoryDir</maml:name>
        <command:parameterValue required="true">String</command:parameterValue>
        <maml:description>
          <maml:para>The directory where the command should store downloaded products.</maml:para>
        </maml:description>
      </command:parameter>
 
      <command:parameter required="false" globbing="false" pipelineinput="false" position="3">
        <maml:name>JournalDir</maml:name>
        <command:parameterValue required="true">String</command:parameterValue>
        <maml:description>
          <maml:para>The directory where the command stores its state, e.g. checkpoints.</maml:para>
        </maml:description>
      </command:parameter>
 
      <command:parameter required="false" globbing="false" pipelineinput="false" position="named">
        <maml:name>IgnoreDependencies</maml:name>
        <command:parameterValue>SwitchParameter</command:parameterValue>
        <maml:description>
          <maml:para>By default, the command downloads the specified product and all its dependencies. This parameter instructs the command to ignore product dependencies.</maml:para>
        </maml:description>
        <dev:defaultvalue>False</dev:defaultvalue>
      </command:parameter>
 
      <command:parameter required="false" globbing="false" pipelineinput="false" position="named">
        <maml:name>AcceptLegalTerms</maml:name>
        <maml:description>
          <maml:para>Automatically accept legal terms. This parameter is mainly intended to be used for automation.</maml:para>
        </maml:description>
        <command:parameterValue>SwitchParameter</command:parameterValue>
        <dev:defaultvalue>False</dev:defaultvalue>
      </command:parameter>
 
      <command:parameter required="false" globbing="false" pipelineinput="false" position="4">
        <maml:name>From</maml:name>
        <command:parameterValue required="true">String</command:parameterValue>
        <maml:description>
          <maml:para>Specifies the individual step where the command starts execution. This parameter is mainly indented to be used for troubleshooting. Allowed values are: Resolve, Download, Cleanup.</maml:para>
        </maml:description>
        <dev:defaultvalue>Resolve</dev:defaultvalue>
      </command:parameter>
 
      <command:parameter required="false" globbing="false" pipelineinput="false" position="5">
        <maml:name>UpTo</maml:name>
        <command:parameterValue required="true">String</command:parameterValue>
        <maml:description>
          <maml:para>Specifies the individual step where the Export.ps1 stop execution. This parameter is mainly indented to be used for troubleshooting. Allowed values are: Resolve, Download, Cleanup.</maml:para>
        </maml:description>
        <dev:defaultvalue>Cleanup</dev:defaultvalue>
      </command:parameter>
 
      <command:parameter required="false" globbing="false" pipelineinput="false" position="6">
        <maml:name>SleepInterval</maml:name>
        <command:parameterValue required="true">Int32</command:parameterValue>
        <maml:description>
          <maml:para>Specifies the inactivity interval in seconds between retries in case of fatal download failures, can be in the range of 5 to 60. This parameter is mainly indented to be used for troubleshooting.</maml:para>
        </maml:description>
        <dev:defaultvalue>60</dev:defaultvalue>
      </command:parameter>
    </command:parameters>
 
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>This command accepts Marketplace items identifiers.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
 
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
      </command:returnValue>
    </command:returnValues>
 
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE: EXPORT PRODUCTS ----------</maml:title>
        <maml:introduction>
          <maml:para>The most common export scenario is shown below.</maml:para>
        </maml:introduction>
        <dev:remarks>
          <maml:para>1. On the machine connected to Internet, connect to Azure Cloud where your stamp is registered, e.g.:</maml:para>
          <maml:para>PS C:\&gt; Login-AzureRmAccount -Credential (Get-Credential) -Environment AzureCloud -Subscription ...</maml:para>
          <maml:para>2. Import &quot;Azs.Syndication.Admin&quot; module:</maml:para>
          <maml:para>PS C:\&gt; Import-Module Azs.Syndication.Admin</maml:para>
          <maml:para>3. Select products to download. You will be asked to select stamp registration, and then you will be asked to select products to download.</maml:para>
          <maml:para>PS C:\&gt; $productIds = Select-AzsMarketplaceItem</maml:para>
          <maml:para>4. Run export procedure, all products will be saved in the .\repos directory:</maml:para>
          <maml:para>PS C:\&gt; $productIds | Export-AzsMarketplaceItem -RepositoryDir .\repos</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
 
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Select-AzsMarketplaceItem</maml:linkText>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Import-AzsMarketplaceItem</maml:linkText>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Register Azure Stack with Azure</maml:linkText>
        <maml:uri>https://docs.microsoft.com/en-us/azure-stack/operator/azure-stack-registration</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
 
  </command:command>
 
</helpItems>