Azs.Syndication.Admin

0.1.157

Import.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>Import-AzsMarketplaceItem</command:name>
      <command:verb>Import</command:verb>
      <command:noun>AzsMarketplaceItem</command:noun>
      <maml:description>
        <maml:para>Import-AzsMarketplaceItem command helps you upload marketplace items from the local disk or file share to Azure Stack stamp marketplace.</maml:para>
      </maml:description>
    </command:details>
 
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Import-AzsMarketplaceItem</maml:name>
 
        <command:parameter required="true" globbing="false" pipelineinput="false" position="1">
          <maml:name>RepositoryDir</maml:name>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="2">
          <maml:name>JournalDir</maml:name>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
 
        <command:parameter required="false" globbing="false" pipelineinput="false" position="3">
          <maml:name>ProductName</maml:name>
          <command:parameterValue required="true">String[]</command:parameterValue>
        </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>Import-AzsMarketplaceItem command helps you upload marketplace items, such as VM images, add-on RPs, and vice versa from the local disk or file share to Azure Stack stamp marketplace.</maml:para>
      <maml:para>The script requires an active Azure Stack Operator's PowerShell session, and you should have write access to the Default Provider Subscription containing the &quot;activation&quot; resource (Microsoft.AzureBridge.Admin/activations) for your stamp.</maml:para>
      <maml:para>While importing products, the script performs the following steps:</maml:para>
      <maml:para>- Create a temporary storage account on the Default Provider Subscription</maml:para>
      <maml:para>- Upload the product artifacts to the newly created temporary storage account</maml:para>
      <maml:para>- Submit the product import jobs through the Azure Bridge and wait for these jobs to complete</maml:para>
      <maml:para>- Remove the temporary storage account to reclaim the space.</maml:para>
      <maml:para>For more information, see the following articles:</maml:para>
      <maml:para>- Register Azure Stack with Azure: https://docs.microsoft.com/en-us/azure-stack/operator/azure-stack-registration</maml:para>
      <maml:para>- Connect to Azure Stack with PowerShell: https://docs.microsoft.com/en-us/azure-stack/operator/azure-stack-powershell-configure-admin</maml:para>
    </maml:description>
 
    <command:parameters>
      <command:parameter required="true" globbing="false" pipelineinput="false" position="1">
        <maml:name>RepositoryDir</maml:name>
        <command:parameterValue required="true">String</command:parameterValue>
        <maml:description>
          <maml:para>The directory where the command looks for the product artifacts, such as disk images and gallery items. Normally, you should use the Export-AzsMarketplaceItem command to prepare this directory.</maml:para>
        </maml:description>
      </command:parameter>
 
      <command:parameter required="false" globbing="false" pipelineinput="false" position="2">
        <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="3">
        <maml:name>ProductName</maml:name>
        <command:parameterValue required="true">String[]</command:parameterValue>
        <maml:description>
          <maml:para>List of the products to import. If not specified, all products in the repository directory will be imported.</maml:para>
        </maml:description>
      </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: Upload, Import, Cleanup.</maml:para>
        </maml:description>
        <dev:defaultvalue>Initialize</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 command stop execution. This parameter is mainly indented to be used for troubleshooting. Allowed values are: Upload, Import, 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 upload 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>None</maml:name>
        </dev:type>
      </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: IMPORT PRODUCTS ----------</maml:title>
        <maml:introduction>
          <maml:para>The most common import scenario is shown below.</maml:para>
        </maml:introduction>
        <dev:remarks>
          <maml:para>1. Use Export-AzsMarketplaceItem command to download productss. Copy the directory containing download product to the machine which has a connection to the stamp.</maml:para>
          <maml:para>2. On the machine connected to the stamp, configure Azure Stack Powershell operator's session and select the Default Provider Subscription. See the following link for details: https://docs.microsoft.com/en-us/azure-stack/operator/azure-stack-powershell-configure-admin</maml:para>
          <maml:para>3. Import &quot;Azs.Syndication.Admin&quot; module:</maml:para>
          <maml:para>PS C:\&gt; Import-Module Azs.Syndication.Admin</maml:para>
          <maml:para>4. Run import command, all products from the .\repos dir will be available in Marketplace:</maml:para>
          <maml:para>PS C:\&gt; Import-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>Export-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>
      <maml:navigationLink>
        <maml:linkText>Connect to Azure Stack with PowerShell</maml:linkText>
        <maml:uri>https://docs.microsoft.com/en-us/azure-stack/operator/azure-stack-powershell-configure-admin</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
 
  </command:command>
 
</helpItems>