Download Marketplace items to Azure Stack Hub

  • Article

As a cloud operator, you can download items to Azure Stack Hub from the Marketplace and make them available to all users using the Azure Stack Hub environment. The items you can choose are from a curated list of Azure Marketplace items that are pre-tested and supported to work with Azure Stack Hub. Additional items are frequently added to this list, so continue to check back for new content.

There are two scenarios for downloading Marketplace products:

  • Disconnected or partially connected scenario: Requires you to access the internet using the Marketplace syndication tool to download Marketplace items. Then, you transfer your downloads to your disconnected Azure Stack Hub installation. This scenario uses PowerShell.
  • Connected scenario: Requires your Azure Stack Hub environment to be connected to the internet. You use the Azure Stack Hub administrator portal to locate and download items.

See Azure Marketplace items for Azure Stack Hub for a complete list of the marketplace items you can download.

Note

The catalog will be different based on the cloud your Azure Stack Hub system is connected to. The cloud environment is determined by the Azure subscription you use for registering your Azure Stack Hub.

Note

You can also use the The Operator Access Workstation (OAW) to access the privileged endpoint (PEP), the Administrator portal for support scenarios, and Azure Stack Hub GitHub Tools. For more information see Azure Stack Hub Operator Access Workstation.

A connected deployment allows you to use the administrator portal to download marketplace items.

Prerequisites

Your Azure Stack Hub deployment must have internet connectivity and be registered with Azure.

Use the portal to download marketplace items

  1. Sign into the Azure Stack Hub administrator portal.

  2. Review the available storage space before downloading marketplace items. Later, when you select items for download, you can compare the download size to your available storage capacity. If capacity is limited, consider options for managing available space.

    To review available space: in Region management, select the region you want to explore and then go to Resource Providers > Storage:

    Review storage space in Azure Stack Hub administrator portal

  3. Open Azure Stack Hub Marketplace and connect to Azure. To do so, select the Marketplace management service, select Marketplace items, and then select Add from Azure:

    Add marketplace items from Azure

  4. Each line item also shows the currently available version. If more than one version of a Marketplace item is available, the Version column shows Multiple. You can click on each item to view its description and additional information, including its download size:

    Screenshot that shows the available versions of a Marketplace item.

  5. If the version of an item is shown as Multiple, you can select that item and then choose a specific version from the resulting version selector dropdown. Note that Microsoft now has the ability to add attributes that block administrators from downloading marketplace products that are incompatible with their Azure Stack, due to various properties, such as the Azure Stack version or billing model. Only Microsoft can add these attributes:

    Add from Azure

  6. Select the item you want, and then select Download. Download times vary and depends on the network connectivity. After the download completes, you can deploy the new marketplace item as either an Azure Stack Hub operator or a user.

  7. To deploy the downloaded item, select + Create a resource, and then search among the categories for the new marketplace item. Next, select the item to begin the deployment process. The process varies for different marketplace items.

When Azure Stack Hub has limited or no internet connectivity, you use PowerShell and the marketplace syndication tool to download the marketplace items to a machine with internet connectivity. You then transfer the items to your Azure Stack Hub environment. In a disconnected environment, you can't download marketplace items by using the Azure Stack Hub portal.

The marketplace syndication tool can also be used in a connected scenario.

There are two parts to this scenario:

  • Part 1: Download from Marketplace items. On the computer with internet access, you configure PowerShell, download the syndication tool, and then download items from Azure Marketplace.
  • Part 2: Upload and publish to Azure Stack Hub Marketplace. You move the files you downloaded to your Azure Stack Hub environment and then publish them to Azure Stack Hub Marketplace.

Prerequisites

  • A connected environment (does not have to be Azure Stack Hub). You need connectivity to get the list of products from Azure with their details, and to download everything locally. Once this is done, the rest of the procedure does not require internet connectivity. It creates a catalog of items you've previously downloaded for you to use in your disconnected environment.

  • Removable media to connect to your disconnected environment and transfer all the necessary artifacts.

  • A disconnected Azure Stack Hub environment with the following prerequisites:

Download the Azs.Syndication.Admin module from the PowerShell Gallery using the following command:

Install-Module -Name Azs.Syndication.Admin

Install-Module -Name Azs.Syndication.Admin -RequiredVersion 0.1.154-preview -AllowPrerelease

Once you have registered your Azure Stack, you can disregard the following message that appears on the Marketplace management blade, as this is not relevant for the disconnected use case:

Marketplace management

Use the marketplace syndication tool to download marketplace items

Be sure to download the marketplace syndication tool each time you download marketplace items in a disconnected scenario. Frequent changes are made to this tool and the most current version should be used for each download.

Important

It's recommended that you use Az modules instead of AzureRM. See the following examples.

  1. On a computer with an Internet connection, open a PowerShell console as an administrator.

  2. Sign in to the appropriate Azure cloud and AzureAD directory tenant using the Azure account that you've used to register Azure Stack Hub. To add the account, in PowerShell run Connect-AzAccount:

    Connect-AzAccount -Environment AzureChinaCloud -Tenant '<mydirectory>.partner.onmschina.cn'

    You are prompted to enter your Azure account credentials and you might have to use two-factor authentication, depending on your account configuration.

    Note

    If your session expires, your password has changed, or you want to switch accounts, run the following cmdlet before you sign in using Connect-AzAccount: Remove-AzAccount -Scope Process.

  3. If you have multiple subscriptions, run the following command to select the one you used for registration:

    Get-AzSubscription -SubscriptionID 'Your Azure Subscription GUID' | Select-AzSubscription

  4. If you haven't done it in the pre-requisites step already, download the latest version of the Marketplace syndication tool if you're using the latest version of Azure Stack Hub:

Install-Module -Name Azs.Syndication.Admin

Install-Module -Name Azs.Syndication.Admin -RequiredVersion 0.1.154-preview -AllowPrerelease

  1. To select the Marketplace items such as VM images, extensions, or solution templates to download, run the following command:

    $products = Select-AzsMarketplaceItem

    This displays a table that lists all the Azure Stack registrations available in the selected subscription. Choose the registration that matches the Azure Stack environment you're downloading the marketplace items for, and select OK.

    Screenshot that shows a list of all the Azure Stack registrations available in the selected subscription.

    You should now see a second table listing all the marketplace items available for download. Select the item that you want to download and make a note of the Version. You can hold the Ctrl key to select multiple images. Screenshot that shows another list of all the Azure Stack registrations available in the selected subscription.

    You can also filter the list of images by using the Add criteria option. Select Azure Stack Registrations

    Once you've made your selections, select OK.

  2. The IDs for the Marketplace items you've selected for download are saved in the $products variable. Use the command below to begin downloading the selected items. Replace the destination folder path with a location to store the files you download from Azure Marketplace:

    $products | Export-AzsMarketplaceItem  -RepositoryDir "Destination folder path in quotes"

  3. The time that the download takes depends on the size of the item. After the download completes, the item is available in the folder that you specified in the script. The download includes a VHD file (for virtual machines), or a .zip file (for virtual machine extensions and resource providers). It might also include a gallery package in the .azpkg format, which is a .zip file.

  4. If the download fails, you can try again by re-running the following PowerShell cmdlet:

    $products | Export-AzsMarketplaceItem  -RepositoryDir "Destination folder path in quotes"

  5. You should also export the Azs.Syndication.Admin module locally so that you can copy it over to the machine from which you are importing Marketplace items to Azure Stack Hub.

    Note

    The destination folder for exporting this module should be different from the location to which you have exported the marketplace items.

    Save-Package -ProviderName NuGet -Source https://www.powershellgallery.com/api/v2 -Name Azs.Syndication.Admin -Path "Destination folder path in quotes" -Force

Import the download and publish to Azure Stack Hub Marketplace using PowerShell

  1. You must move the files that you have previously downloaded locally to a machine that has connectivity to your Azure Stack Hub environment. The marketplace syndication tool must also be available to your Azure Stack Hub environment because you need to use the tool to perform the import operation.

    The following image shows a folder structure example. D:\downloadfolder contains all the downloaded marketplace items. Each subfolder is a marketplace item (for example, microsoft.custom-script-linux-arm-2.0.3), named by the product ID. Inside each subfolder is the marketplace item's downloaded content.

    Marketplace download directory structure

  2. Follow the instructions in Connect to Azure Stack Hub with PowerShell to configure the Azure Stack Hub operator PowerShell session.

  3. Sign in to your Azure Stack Hub with an identity that has owner access to the Default Provider Subscription.

  4. Copy the name of the folder; for example, microsoft.dsc-arm-2.77.0, and create a folder with that name.

  5. Move the downloaded folder to that folder. At this point, you have C:\microsoft.dsc-arm-2.77.0\microsoft.dsc-arm-2.77.0\original-sub-folders-are-here and C:\microsoft.dsc-arm-2.77.0\microsoft.dsc-arm-2.77.0\productDetails.json.

  6. Import the syndication module and then launch the marketplace syndication tool by running the following cmdlet:

    Import-AzsMarketplaceItem -RepositoryDir "C:\microsoft.dsc-arm-2.77.0"

  7. After the cmdlet successfully completes, the marketplace items should be available in Azure Stack Hub Marketplace.

Next steps

Connect to Azure Stack Hub with PowerShell