Een aangepast Azure Stack hub Marketplace-item maken en publicerenCreate and publish a custom Azure Stack Hub Marketplace item

Elk item dat is gepubliceerd op de Azure Stack hub Marketplace, maakt gebruik van de Azure Gallery pakket-indeling (. azpkg).Every item published to the Azure Stack Hub Marketplace uses the Azure Gallery Package (.azpkg) format. Met het hulp programma Azure Gallery packager kunt u een aangepast Azure Gallery-pakket maken dat u kunt uploaden naar de Azure stack hub Marketplace, die vervolgens door gebruikers kan worden gedownload.The Azure Gallery Packager tool enables you to create a custom Azure Gallery package that you can upload to the Azure Stack Hub Marketplace, which can then be downloaded by users. Het implementatie proces maakt gebruik van een Azure Resource Manager sjabloon.The deployment process uses an Azure Resource Manager template.

Marketplace-itemsMarketplace items

In de voor beelden in dit artikel ziet u hoe u één VM-Marketplace-aanbod maakt, van het type Windows of Linux.The examples in this article show how to create a single VM Marketplace offer, of type Windows or Linux.

VereistenPrerequisites

Ga als volgt te werk voordat u het item VM Marketplace maakt:Before creating the VM marketplace item, do the following:

  1. Upload de aangepaste VM-installatie kopie naar de Azure Stack hub-Portal en volg de instructies in een VM-installatie kopie toevoegen aan Azure stack hub.Upload the custom VM image to the Azure Stack Hub portal, following the instructions in Add a VM image to Azure Stack Hub.
  2. Volg de instructies in dit artikel om de installatie kopie te verpakken (Maak een. azpkg) en upload deze naar de Marketplace van Azure Stack hub.Follow the instructions in this article to package the image (create an .azpkg) and upload it to the Azure Stack Hub Marketplace.

Een Marketplace-item makenCreate a Marketplace item

Ga als volgt te werk om een aangepast Marketplace-item te maken:To create a custom marketplace item, do the following:

  1. Down load het Azure Gallery packager-hulp programma en het pakket met de voor beeld-Azure stack hub-galerie.Download the Azure Gallery Packager tool and the sample Azure Stack Hub gallery package. Deze down load omvat aangepaste VM-sjablonen.This download includes custom VM templates. Pak het zip-bestand en onder de aangepaste virtuele machines van de map uit. u kunt hiervoor de Linux-of de Windows-sjablonen gebruiken die beschikbaar zijn.Extract the .zip file, and under the folder Custom VMs, you can use either the Linux or the Windows templates that are available. U kunt ervoor kiezen om de vooraf gemaakte sjablonen opnieuw te gebruiken en de betreffende para meters te wijzigen met de product details van het item dat u wilt weer geven op uw Azure Stack hub-Portal.You can decide to re-use the pre-made templates and modify the respective parameters with the product details of the item that you will show on your Azure Stack Hub portal. U kunt ook gewoon het. azpkg-bestand opnieuw gebruiken en de volgende stappen overs Laan om uw eigen galerie pakket aan te passen.Or, you can simply re-use the .azpkg file available and skip the following steps to customize your own gallery package.

  2. Maak een Azure Resource Manager sjabloon of gebruik onze voorbeeld sjablonen voor Windows/Linux.Create an Azure Resource Manager template or use our sample templates for Windows/Linux. Deze voorbeeld sjablonen zijn opgenomen in het hulp programma packager. zip-bestand dat u in stap 1 hebt gedownload.These sample templates are provided in the packager tool .zip file you downloaded in step 1. U kunt de sjabloon gebruiken en de tekst velden wijzigen, maar u kunt ook een vooraf geconfigureerde sjabloon downloaden van GitHub.You can either use the template and change the text fields, or you can download a pre-configured template from GitHub. Zie Azure Resource Manager-sjablonenvoor meer informatie over Azure Resource Manager sjablonen.For more information about Azure Resource Manager templates, see Azure Resource Manager templates.

  3. Het Galerie pakket moet de volgende structuur bevatten:The Gallery package should contain the following structure:

    Scherm afbeelding van de structuur van het Galerie pakket

    De bestands structuur van de implementatie sjablonen ziet er als volgt uit:The deployment templates file structure appears as follows:

    Scherm afbeelding van de structuur van de implementatie sjablonen

  4. Vervang de volgende gemarkeerde waarden (die met getallen) in het Manifest.jsop de sjabloon door de waarde die u hebt ingevoerd bij het uploaden van uw aangepaste installatie kopie.Replace the following highlighted values (those with numbers) in the Manifest.json template with the value that you provided when uploading your custom image.

    Notitie

    U kunt nooit uw persoonlijke gegevens, zoals product codes, wacht woorden of door de klant geïdentificeerde informatie in de Azure Resource Manager sjabloon, op een vaste code.Never hard code any secrets such as product keys, password, or any customer identifiable information in the Azure Resource Manager template. JSON-bestanden van de sjabloon zijn toegankelijk zonder dat de verificatie nood zakelijk is nadat deze is gepubliceerd in de galerie.Template JSON files are accessible without the need for authentication once published in the gallery. Sla alle geheimen op in Key Vault en roep ze aan vanuit de sjabloon.Store all secrets in Key Vault and call them from within the template.

    Het is raadzaam om voordat u uw eigen aangepaste sjabloon publiceert, het voor beeld te publiceren en ervoor te zorgen dat deze in uw omgeving werkt.It's recommended that before publishing your own custom template, you try to publish the sample as-is and make sure it works in your environment. Zodra u hebt gecontroleerd of deze stap werkt, verwijdert u het voor beeld uit de galerie en voert u terugkerende wijzigingen uit totdat u tevreden bent met het resultaat.Once you've verified this step works, then delete the sample from gallery and make iterative changes until you are satisfied with the result.

    De volgende sjabloon is een voor beeld van de Manifest.jsvoor het bestand:The following template is a sample of the Manifest.json file:

    {
       "$schema": "https://gallery.azure.com/schemas/2015-10-01/manifest.json#",
       "name": "Test", (1)
       "publisher": "<Publisher name>", (2)
       "version": "<Version number>", (3)
       "displayName": "ms-resource:displayName", (4)
       "publisherDisplayName": "ms-resource:publisherDisplayName", (5)
       "publisherLegalName": "ms-resource:publisherDisplayName", (6)
       "summary": "ms-resource:summary",
       "longSummary": "ms-resource:longSummary",
       "description": "ms-resource:description",
       "longDescription": "ms-resource:description",
       "links": [
        { "displayName": "ms-resource:documentationLink", "uri": "http://go.microsoft.com/fwlink/?LinkId=532898" }
        ],
       "artifacts": [
          {
             "isDefault": true
          }
       ],
       "images": [{
          "context": "ibiza",
          "items": [{
             "id": "small",
             "path": "icons\\Small.png", (7)
             "type": "icon"
             },
             {
                "id": "medium",
                "path": "icons\\Medium.png",
                "type": "icon"
             },
             {
                "id": "large",
                "path": "icons\\Large.png",
                "type": "icon"
             },
             {
                "id": "wide",
                "path": "icons\\Wide.png",
                "type": "icon"
             }]
        }]
    }
    

    In de volgende lijst worden de voor gaande genummerde waarden in de voorbeeld sjabloon uitgelegd:The following list explains the preceding numbered values in the example template:

    • (1)-de naam van de aanbieding.(1) - The name of the offer.
    • (2): de naam van de uitgever, zonder spatie.(2) - The name of the publisher, without a space.
    • (3): de versie van uw sjabloon, zonder een spatie.(3) - The version of your template, without a space.
    • (4): de naam die door klanten wordt weer geven.(4) - The name that customers see.
    • (5): de naam van de uitgever die door klanten wordt weer geven.(5) - The publisher name that customers see.
    • (6)-de naam van de uitgever.(6) - The publisher legal name.
    • (7): het pad en de naam voor elk pictogram.(7) - The path and name for each icon.
  5. Voor alle velden die verwijzen naar MS-resource, moet u de juiste waarden in de teken reeksen/resources.jsvoor het bestand wijzigen:For all fields referring to ms-resource, you must change the appropriate values inside the strings/resources.json file:

    {
    "displayName": "<OfferName.PublisherName.Version>",
    "publisherDisplayName": "<Publisher name>",
    "summary": "Create a simple VM",
    "longSummary": "Create a simple VM and use it",
    "description": "<p>This is just a sample of the type of description you could create for your gallery item!</p><p>This is a second paragraph.</p>",
    "documentationLink": "Documentation"
    }
    
  6. Om ervoor te zorgen dat de resource correct kan worden geïmplementeerd, test u de sjabloon met de Api's van de Azure stack hub.To ensure that the resource can be deployed successfully, test the template with the Azure Stack Hub APIs.

  7. Als uw sjabloon afhankelijk is van een installatie kopie van een virtuele machine (VM), volgt u de instructies om een VM-installatie kopie toe te voegen aan Azure stack hub.If your template relies on a virtual machine (VM) image, follow the instructions to add a VM image to Azure Stack Hub.

  8. Sla uw Azure Resource Manager sjabloon op in de map /contoso.TodoList/DeploymentTemplates/ .Save your Azure Resource Manager template in the /Contoso.TodoList/DeploymentTemplates/ folder.

  9. Kies de pictogrammen en tekst voor uw Marketplace-item.Choose the icons and text for your Marketplace item. Voeg pictogrammen toe aan de map pictogrammen en voeg tekst toe aan het resources -bestand in de map strings .Add icons to the Icons folder, and add text to the resources file in the Strings folder. Gebruik de kleine, middel grote, lange en brede naamgevings Conventie voor pictogrammen.Use the small, medium, large, and wide naming convention for icons. Zie de Naslag informatie voor de gebruikers interface voor Marketplace-items voor een gedetailleerde beschrijving van deze grootten.See the Marketplace item UI reference for a detailed description of these sizes.

    Notitie

    De vier pictogram grootten (klein, gemiddeld, groot en breed) zijn vereist om het Marketplace-item correct te bouwen.All four icon sizes (small, medium, large, wide) are required for building the Marketplace item correctly.

  10. Zie Naslag informatie: marketplace-item manifest.jsopvoor verdere wijzigingen in Manifest.js.For any further edits to Manifest.json, see Reference: Marketplace item manifest.json.

  11. Wanneer u klaar bent met het wijzigen van uw bestanden, converteert u deze naar een. azpkg-bestand.When you finish modifying your files, convert it to an .azpkg file. U voert de conversie uit met behulp van de AzureGallery.exe tool en het pakket met de voorbeeld galerie dat u eerder hebt gedownload.You perform the conversion using the AzureGallery.exe tool and the sample gallery package you downloaded previously. Voer de volgende opdracht uit:Run the following command:

    .\AzureGallery.exe package -m c:\<path>\<gallery package name>\manifest.json -o c:\Temp
    

    Notitie

    Het uitvoerpad kan elk pad zijn dat u kiest en hoeft zich niet onder station C: te bevinden.The output path can be any path you choose, and does not have to be under the C: drive. Het volledige pad naar zowel de manifest.jsvoor het bestand en het uitvoer pakket moet echter bestaan.However, the full path to both the manifest.json file, and the output package, must exist. Als het uitvoerpad bijvoorbeeld is C:\<path>\galleryPackageName.azpkg , moet de map C:\<path> bestaan.For example, if the output path is C:\<path>\galleryPackageName.azpkg, the folder C:\<path> must exist.

Een Marketplace-item publicerenPublish a Marketplace item

  1. Gebruik Power shell of Azure Storage Explorer om uw Marketplace-item (. azpkg) te uploaden naar Azure Blob-opslag.Use PowerShell or Azure Storage Explorer to upload your Marketplace item (.azpkg) to Azure Blob storage. U kunt uploaden naar lokale Azure Stack hub-opslag of uploaden naar Azure Storage. Dit is een tijdelijke locatie voor het pakket.You can upload to local Azure Stack Hub storage or upload to Azure Storage, which is a temporary location for the package. Zorg ervoor dat de BLOB openbaar toegankelijk is.Make sure that the blob is publicly accessible.

  2. Als u het Galerie pakket wilt importeren in Azure Stack hub, is de eerste stap om het bestand dat u zojuist hebt gemaakt op uw Azure Stack hub, op afstand te verbinden met de client-VM.To import the gallery package into Azure Stack Hub, the first step is to remotely connect (RDP) to the client VM, in order to copy the file you just created to your Azure Stack Hub.

  3. Een context toevoegen:Add a context:

    $ArmEndpoint = "https://adminmanagement.local.azurestack.external"
    Add-AzEnvironment -Name "AzureStackAdmin" -ArmEndpoint $ArmEndpoint
    Add-AzAccount -EnvironmentName "AzureStackAdmin"
    
  4. Voer het volgende script uit om de resource te importeren in uw galerie:Run the following script to import the resource into your gallery:

    Add-AzsGalleryItem -GalleryItemUri `
    https://sample.blob.core.windows.net/<temporary blob name>/<offerName.publisherName.version>.azpkg -Verbose
    
  5. Controleer of u een geldig opslag account hebt dat beschikbaar is voor het opslaan van uw item.Verify that you have a valid Storage account that is available to store your item. U kunt de GalleryItemURI waarde ophalen uit de Azure stack hub-beheerder Portal.You can get the GalleryItemURI value from the Azure Stack Hub administrator portal. Selecteer een opslag account-> BLOB-eigenschappen-> URL, met de extensie. azpkg.Select Storage account -> Blob Properties -> URL, with the extension .azpkg. Het opslag account is alleen voor tijdelijk gebruik, om naar de Marketplace te publiceren.The storage account is only for temporary use, in order to publish to the marketplace.

    Nadat u uw galerie pakket hebt voltooid en dit hebt geüpload met behulp van add-AzsGalleryItem, moet uw aangepaste VM nu worden weer gegeven in de Marketplace en in de weer gave een resource maken .After completing your gallery package and uploading it using Add-AzsGalleryItem, your custom VM should now appear on the Marketplace as well as in the Create a resource view. Houd er rekening mee dat het aangepaste galerie pakket niet wordt weer gegeven in Marketplace-beheer.Note that the custom gallery package is not visible in Marketplace Management.

    Aangepast Marketplace-item geüploadCustom marketplace item uploaded

  6. Nadat het item is gepubliceerd naar de Marketplace, kunt u de inhoud uit het opslag account verwijderen.Once your item has been successfully published to the marketplace, you can delete the content from the storage account.

    Alle standaard-galerij artefacten en uw aangepaste galerie-artefacten zijn nu toegankelijk zonder verificatie onder de volgende Url's:All default gallery artifacts and your custom gallery artifacts are now accessible without authentication under the following URLs:

    • https://galleryartifacts.adminhosting.[Region].[externalFQDN]/artifact/20161101/[TemplateName]/DeploymentTemplates/Template.json
    • https://galleryartifacts.hosting.[Region].[externalFQDN]/artifact/20161101/[TemplateName]/DeploymentTemplates/Template.json
  7. U kunt een Marketplace-item verwijderen met de cmdlet Remove-AzGalleryItem .You can remove a Marketplace item by using the Remove-AzGalleryItem cmdlet. Bijvoorbeeld:For example:

    Remove-AzsGalleryItem -Name <Gallery package name> -Verbose
    

Notitie

De Marketplace-gebruikers interface kan een fout weer geven nadat u een item hebt verwijderd.The Marketplace UI may show an error after you remove an item. Klik op instellingen in de portal om de fout op te lossen.To fix the error, click Settings in the portal. Selecteer vervolgens wijzigingen negeren onder Portal aanpassing.Then, select Discard modifications under Portal customization.

Verwijzing: marketplace-item manifest.jsopReference: Marketplace item manifest.json

Identiteits gegevensIdentity information

NaamName VereistRequired TypeType BeperkingenConstraints BeschrijvingDescription
NaamName XX TekenreeksString [A-Za-z0-9] +[A-Za-z0-9]+
PublisherPublisher XX TekenreeksString [A-Za-z0-9] +[A-Za-z0-9]+
VersieVersion XX TekenreeksString SemVer v2SemVer v2

MetagegevensMetadata

NaamName VereistRequired TypeType BeperkingenConstraints BeschrijvingDescription
DisplayNameDisplayName XX TekenreeksString Aanbeveling van 80 tekensRecommendation of 80 characters De naam van uw item wordt mogelijk niet correct weer gegeven in de portal als deze langer is dan 80 tekens.The portal might not display your item name correctly if it's longer than 80 characters.
PublisherDisplayNamePublisherDisplayName XX TekenreeksString Aanbeveling van 30 tekensRecommendation of 30 characters De naam van de uitgever wordt mogelijk niet correct weer gegeven in de portal als deze langer is dan 30 tekens.The portal might not display your publisher name correctly if it's longer than 30 characters.
PublisherLegalNamePublisherLegalName XX TekenreeksString Maxi maal 256 tekensMaximum of 256 characters
SamenvattingSummary XX TekenreeksString 60 tot 100 tekens60 to 100 characters
LongSummaryLongSummary XX TekenreeksString 140 tot 256 tekens140 to 256 characters Nog niet van toepassing in Azure Stack hub.Not yet applicable in Azure Stack Hub.
BeschrijvingDescription XX HTMLHTML 500 tot 5.000 tekens500 to 5,000 characters

InstallatiekopieënImages

De Marketplace gebruikt de volgende pictogrammen:The Marketplace uses the following icons:

NaamName BreedteWidth HoogteHeight OpmerkingenNotes
OrganisatiebreedWide 255 PX255 px 115 PX115 px Altijd vereistAlways required
GrootLarge 115 PX115 px 115 PX115 px Altijd vereistAlways required
NormaalMedium 90 PX90 px 90 PX90 px Altijd vereistAlways required
KleinSmall 40 PX40 px 40 PX40 px Altijd vereistAlways required
SchermopnameScreenshot 533 PX533 px 324 PX324 px OptioneelOptional

CategorieënCategories

Elk Marketplace-item moet worden gelabeld met een categorie die aangeeft waar het item wordt weer gegeven in de portal-gebruikers interface.Each Marketplace item should be tagged with a category that identifies where the item appears on the portal UI. U kunt een van de bestaande categorieën kiezen in Azure Stack hub (Compute, Data + Storage, enzovoort) of een nieuwe categorie kiezen.You can choose one of the existing categories in Azure Stack Hub (Compute, Data + Storage, and so on) or choose a new one.

Elk Marketplace-item kan verschillende koppelingen naar extra inhoud bevatten.Each Marketplace item can include various links to additional content. De koppelingen zijn opgegeven als een lijst met namen en Uri's:The links are specified as a list of names and URIs:

NaamName VereistRequired TypeType BeperkingenConstraints BeschrijvingDescription
DisplayNameDisplayName XX TekenreeksString Maxi maal 64 tekens.Maximum of 64 characters.
URIUri XX URIURI

Aanvullende eigenschappenAdditional properties

Naast de voor gaande meta gegevens kunnen auteurs van Marketplace aangepaste sleutel/waarde-paar gegevens opgeven in de volgende vorm:In addition to the preceding metadata, Marketplace authors can provide custom key/value pair data in the following form:

NaamName VereistRequired TypeType BeperkingenConstraints BeschrijvingDescription
DisplayNameDisplayName XX TekenreeksString Maxi maal 25 tekens.Maximum of 25 characters.
WaardeValue XX TekenreeksString Maxi maal 30 tekens.Maximum of 30 characters.

HTML-opschoningHTML sanitization

Voor elk veld dat HTML toestaat, zijn de volgende elementen en kenmerken toegestaan:For any field that allows HTML, the following elements and attributes are allowed:

h1, h2, h3, h4, h5, p, ol, ul, li, a[target|href], br, strong, em, b, i

Verwijzing: gebruikers interface voor Marketplace-itemReference: Marketplace item UI

Hier volgen pictogrammen en tekst voor Marketplace-items die in de Azure Stack hub-Portal worden weer gegeven.Icons and text for Marketplace items as seen in the Azure Stack Hub portal are as follows.

Blade makenCreate blade

Blade maken: Azure Stack hub Marketplace-items

Blade Details Marketplace-itemMarketplace item details blade

Blade Details van de Azure Stack hub Marketplace-items

Volgende stappenNext steps