Vytvoření a publikování vlastní položky marketplace služby Azure Stack Hub
Každá položka publikovaná na marketplace služby Azure Stack Hub používá formát balíčku galerie Azure (.azpkg). Nástroj Azure Gallery Packager umožňuje vytvořit vlastní balíček galerie Azure, který můžete nahrát na Marketplace služby Azure Stack Hub, který pak můžou stáhnout uživatelé. Proces nasazení používá šablonu Azure Resource Manageru.
Položky z Marketplace
Příklady v tomto článku ukazují, jak vytvořit jednu nabídku marketplace virtuálních počítačů typu Windows nebo Linux.
Požadavky
Před vytvořením položky marketplace virtuálního počítače postupujte takto:
- Nahrajte vlastní image virtuálního počítače na portál Azure Stack Hub podle pokynů v Přidání image virtuálního počítače do služby Azure Stack Hub.
- Podle pokynů v tomto článku zabalte image (vytvořte .azpkg) a nahrajte ji na Marketplace služby Azure Stack Hub.
Vytvoření položky Marketplace
Pokud chcete vytvořit vlastní položku marketplace, postupujte takto:
Stáhněte si nástroj Azure Gallery Packager:
Nástroj obsahuje ukázkové balíčky, které jsou ve formátu .azpkg a musí být extrahovány jako první. Přípony souborů můžete přejmenovat z ".azpkg" na ".zip", nebo můžete použít archivační nástroj podle vašeho výběru:
balíčky
Po extrahování soubor .zip obsahuje dostupné šablony Linuxu nebo Windows Azure Resource Manageru. Předem vytvořené šablony Resource Manageru můžete znovu použít a upravit příslušné parametry s podrobnostmi o produktu položky, kterou zobrazíte na portálu Azure Stack Hub. Nebo můžete znovu použít soubor .azpkg a přeskočit následující kroky k přizpůsobení vlastního balíčku galerie.
Vytvořte šablonu Azure Resource Manageru nebo použijte naše ukázkové šablony pro Windows/Linux. Tyto ukázkové šablony jsou k dispozici v souboru .zip nástroje packager, který jste stáhli v kroku 1. Můžete použít šablonu a změnit textová pole, nebo si můžete stáhnout předem nakonfigurovanou šablonu z GitHubu. Další informace o šablonách Azure Resource Manageru najdete v tématu šablon Azure Resource Manageru.
Balíček galerie by měl obsahovat následující strukturu:
V šabloně Manifest.json nahraďte následující zvýrazněné hodnoty (ty, které mají čísla) hodnotou, kterou jste zadali při nahrání vlastního obrázku.
Poznámka
Nikdy nezakódujte žádné tajné kódy, jako jsou kódy Product Key, heslo nebo jakékoli identifikovatelné informace zákazníka v šabloně Azure Resource Manageru. Soubory JSON šablony jsou přístupné bez nutnosti ověřování po publikování v galerii. Uložte všechny tajné kódy ve službě Key Vault a volejte je z šablony.
Před publikováním vlastní šablony se doporučuje publikovat ukázkovou as-is a ujistit se, že funguje ve vašem prostředí. Jakmile ověříte, že tento krok funguje, odstraňte ukázku z galerie a proveďte iterativní změny, dokud nebudete s výsledkem spokojeni.
Následující šablona je ukázka souboru Manifest.json:
{ "$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" }] }] }
Následující seznam vysvětluje předchozí číslované hodnoty v ukázkové šabloně:
- (1) - Název nabídky.
- (2) - Jméno vydavatele bez mezery.
- (3) – Verze šablony bez mezery.
- (4) – název, který vidí zákazníci.
- (5) – název vydavatele, který vidí zákazníci.
- (6) - Právní název vydavatele.
- (7) - Cesta a název každé ikony.
U všech polí odkazujících na ms-resourceje nutné změnit příslušné hodnoty v souboru řetězce/resources.json.
{ "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" }
Struktura souborů šablon nasazení se zobrazí takto:
Nahraďte hodnoty obrázku v souboru createuidefinition.json hodnotou, kterou jste zadali při nahrávání vlastní image.
Pokud chcete zajistit úspěšné nasazení prostředku, otestujte šablonu pomocí rozhraní API služby Azure Stack Hub.
Pokud vaše šablona spoléhá na image virtuálního počítače, postupujte podle pokynů k přidání image virtuálního počítače do služby Azure Stack Hub.
Uložte šablonu Azure Resource Manageru do složky /Contoso.TodoList/DeploymentTemplates/.
Zvolte ikony a text položky Marketplace. Přidejte ikony do složky Ikony a do souboru Prostředky ve složce Řetězce přidejte text. Pro ikony použijte konvenci názvů: malé, střední, velkéa široké. Podrobný popis těchto velikostí najdete v referenční dokumentaci k uživatelskému rozhraní položky Marketplace .
Poznámka
Všechny čtyři velikosti ikon (malé, střední, velké, široké) se vyžadují pro správné sestavení položky Marketplace.
Další úpravy Manifest.jsonnajdete v tématu Reference: Položka marketplace manifest.json.
Po dokončení úprav souborů ho převeďte na soubor .azpkg. Převod provedete pomocí nástroje AzureGallery.exe a balíčku ukázkové galerie, který jste si stáhli dříve. Spusťte následující příkaz:
.\AzureStackHubGallery.exe package -m c:\<path>\<gallery package name>\manifest.json -o c:\Temp
Poznámka
Výstupní cesta může být libovolná cesta, kterou zvolíte, a nemusí být pod jednotkou C: . Úplná cesta k souboru manifest.json i výstupnímu balíčku však musí existovat. Pokud je například výstupní cesta
C:\<path>\galleryPackageName.azpkg
, musí existovat složka,C:\<path>
.
Publikování položky z Marketplace
- moduly Az
- moduly AzureRM
Pomocí PowerShellu nebo Průzkumníka služby Azure Storage nahrajte položku Marketplace (.azpkg) do služby Azure Blob Storage. Můžete nahrát do místního úložiště služby Azure Stack Hub nebo nahrát do služby Azure Storage, což je dočasné umístění balíčku. Ujistěte se, že blob je veřejně přístupný.
Pokud chcete importovat balíček galerie do služby Azure Stack Hub, prvním krokem je vzdálené připojení (RDP) k klientskému virtuálnímu počítači, abyste mohli zkopírovat soubor, který jste právě vytvořili do služby Azure Stack Hub.
Přidejte kontext:
$ArmEndpoint = "https://adminmanagement.local.azurestack.external" Add-AzEnvironment -Name "AzureStackAdmin" -ArmEndpoint $ArmEndpoint Connect-AzAccount -EnvironmentName "AzureStackAdmin"
Spuštěním následujícího skriptu naimportujte prostředek do galerie:
Add-AzsGalleryItem -GalleryItemUri ` https://sample.blob.core.windows.net/<temporary blob name>/<offerName.publisherName.version>.azpkg -Verbose
Pokud při spuštění Add-AzsGalleryItem dojde k chybě, možná máte nainstalované dvě verze modulu
gallery.admin
. Odeberte všechny verze modulu a nainstalujte nejnovější verzi. Postup odinstalace modulů PowerShellu najdete v tématu Odinstalace existujících verzí modulů PowerShellu služby Azure Stack Hub.Ověřte, že máte platný účet úložiště, který je k dispozici pro uložení položky. Hodnotu
GalleryItemURI
získáte z portálu pro správu služby Azure Stack Hub. Vyberte účet úložiště –> vlastnosti objektu blob –>adresy URL s příponou .azpkg. Účet úložiště je určený pouze k dočasnému použití, aby bylo možné ho publikovat na marketplace.Po dokončení balíčku galerie a jeho nahrání pomocí Add-AzsGalleryItemby se váš vlastní virtuální počítač měl zobrazit na Marketplace a také v zobrazení Vytvoření prostředku. Všimněte si, že balíček vlastní galerie není viditelný v marketplace Management.
Po úspěšném publikování položky na marketplace můžete obsah z účtu úložiště odstranit.
Všechny výchozí artefakty galerie a artefakty vlastní galerie jsou teď přístupné bez ověřování pod následujícími adresami URL:
https://galleryartifacts.adminhosting.[Region].[externalFQDN]/artifact/20161101/[TemplateName]/DeploymentTemplates/Template.json
https://galleryartifacts.hosting.[Region].[externalFQDN]/artifact/20161101/[TemplateName]/DeploymentTemplates/Template.json
Položku Marketplace můžete odebrat pomocí rutiny Remove-AzGalleryItem. Například:
Remove-AzsGalleryItem -Name <Gallery package name> -Verbose
Poznámka
Po odebrání položky se v uživatelském rozhraní Marketplace může zobrazit chyba. Chybu opravíte kliknutím na Nastavení na portálu. Potom vyberte v části přizpůsobení portálu možnost Zahodit úpravy.
Referenční informace: Položka Marketplace manifest.json
Informace o identitě
Jméno | Požadovaný | Typ | Omezení | Popis |
---|---|---|---|---|
Jméno | X | Řetězec | [A-Za-z0-9]+ | |
Vydavatel | X | Řetězec | [A-Za-z0-9]+ | |
Verze | X | Řetězec | SemVer v2 |
Metadata
Obrazy
Marketplace používá následující ikony:
Jméno | Šířka | Výška | Poznámky |
---|---|---|---|
Široký | 255 px | 115 px | Vždy se vyžaduje |
Velký | 115 px | 115 px | Vždy se vyžaduje |
Středně | 90 px | 90 px | Vždy se vyžaduje |
Malý | 40 px | 40 px | Vždy vyžadováno |
Snímek obrazovky | 533 px | 324 px | Volitelný |
Kategorie
Každá položka Marketplace by měla být označená kategorií, která identifikuje, kde se položka zobrazuje v uživatelském rozhraní portálu. Můžete zvolit jednu z existujících kategorií ve službě Azure Stack Hub (compute, data a úložištěatd.) nebo zvolit novou.
Odkazy
Každá položka Marketplace může obsahovat různé odkazy na další obsah. Odkazy se zadají jako seznam názvů a identifikátorů URI:
Jméno | Povinné | Typ | Omezení | Popis |
---|---|---|---|---|
Zobrazované jméno | X | Řetězec | Maximálně 64 znaků. | |
URI | X | URI |
Další vlastnosti
Kromě předchozích metadat můžou autoři Marketplace poskytnout vlastní data páru klíč/hodnota v následujícím formátu:
Jméno | Povinný | Typ | Omezení | Popis |
---|---|---|---|---|
DisplayName | X | Řetězec | Maximálně 25 znaků. | |
Hodnota | X | Řetězec | Maximálně 30 znaků. |
Sanitizace HTML
Pro každé pole, které umožňuje HTML, jsou povoleny následující elementy a atributy:
h1, h2, h3, h4, h5, p, ol, ul, li, a[target|href], br, strong, em, b, i
Referenční informace: Uživatelské rozhraní položky Marketplace
Ikony a text položek Marketplace, jak je vidět na portálu Azure Stack Hub, jsou následující.
Vytvořit čepel
Okno Podrobnosti o položce Marketplace
Další kroky
- přehled marketplace služby Azure Stack Hub
- Stáhnout položky z Marketplace
- Formát a struktura šablon Azure Resource Manageru