Azure Stack Hub でカスタム Marketplace アイテムを作成して発行する
Azure Stack Hub Marketplace に発行されるすべてのアイテムでは、Azure ギャラリー パッケージ (.azpkg) 形式を使用します。 Azure Gallery Packager ツールを使用すると、Azure Stack Hub の Marketplace にアップロードしてユーザーが後からダウンロードできる、カスタム Azure ギャラリー パッケージを作成できます。 デプロイ プロセスでは、Azure Resource Manager テンプレートを使用します。
Marketplace アイテム
この記事の例では、Windows または Linux の種類で単一の VM Marketplace オファーを作成する方法について説明します。
前提条件
VM Marketplace アイテムを作成する前に、次の手順を実行します。
- VM イメージの Azure Stack Hub への追加に関するページの手順に従って、カスタム VM イメージを Azure Stack Hub ポータルにアップロードします。
- この記事の手順に従ってイメージをパッケージ化し (.azpkg を作成)、それを Azure Stack Hub の Marketplace にアップロードします。
Marketplace アイテムの作成
カスタム Marketplace アイテムを作成するには、次の手順のようにします。
Azure Gallery Packager ツールをダウンロードします。
このツールには、.azpkg 形式のサンプル パッケージが含まれているため、最初に抽出する必要があります。 ファイル拡張子の名前を ".azpkg" から ".zip" に変更することも、任意のアーカイバー ツールを使用することもできます。
抽出すると、.zip ファイルに使用可能な Linux または Windows の Azure Resource Manager テンプレートが含まれます。 事前に作成されている Resource Manager テンプレートを再利用して、各パラメーターを、Azure Stack Hub ポータルに表示するアイテムの製品詳細に指定して変更できます。 また、.azpkg ファイルを再利用すると、次の手順をスキップして独自のギャラリー パッケージをカスタマイズできます。
Azure Resource Manager テンプレートを作成するか、Windows/Linux 用のサンプル テンプレートを使用します。 これらのサンプル テンプレートは、手順 1 でダウンロードした Packager ツールの .zip ファイルで提供されています。 テンプレートを使用してテキスト フィールドを変更するか、構成済みのテンプレートを GitHub からダウンロードすることができます。 Azure Resource Manager テンプレートの詳細については、Azure Resource Manager テンプレートに関するページを参照してください。
ギャラリー パッケージは、次のような構造になっている必要があります。
Manifest.json テンプレートで次の強調表示されている値 (番号が付いているもの) を、カスタム イメージをアップロードするときに指定した値に置き換えます。
注意
プロダクト キー、パスワード、お客様を特定できる情報などの機密情報を Azure Resource Manager テンプレートにハード コーディングしないでください。 テンプレート JSON ファイルは、ギャラリーで公開されると、認証の必要なくアクセスできます。 機密情報はすべて Key Vault に格納し、テンプレート内から呼び出してください。
独自のカスタム テンプレートを発行する前に、サンプルをそのまま発行して、環境内で動作することを確認することをお勧めします。 この手順が正常に実行されたことを確認したら、ギャラリーからサンプルを削除し、結果に満足できるまで反復的な変更を行います。
次のテンプレートは、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" }] }] }次の一覧では、前のテンプレート例で示した番号付きの値について説明します。
- (1) - オファーの名前。
- (2) - 公開元の名前 (スペースが含まれないもの)。
- (3) - テンプレートのバージョン (スペースが含まれないもの)。
- (4) - 顧客に表示される名前。
- (5) - 顧客に表示される公開元の名前。
- (6) - 公開元の正式な名前。
- (7) - 各アイコンのパスと名前。
ms-resource が参照されているすべてのフィールドを、strings/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" }デプロイ テンプレート ファイルの構造は次のように表示されます。
createuidefinition.js ファイルにあるイメージの値を、カスタム イメージをアップロードするときに指定した値に置き換えます。
リソースを正常にデプロイできるようにするには、Azure Stack Hub API を使用してテンプレートをテストします。
お使いのテンプレートが仮想マシン (VM) のイメージに依存する場合、指示に従って Azure Stack Hub に VM イメージを追加します。
Azure Resource Manager テンプレートを /Contoso.TodoList/DeploymentTemplates/ フォルダーに保存します。
Marketplace アイテムのアイコンとテキストを選択します。 Icons フォルダーにアイコンを追加し、Strings フォルダー内の resources ファイルにテキストを追加します。 アイコンには small、medium、large、および wide の名前付け規則を使用します。 これらのサイズの詳細については、「Marketplace アイテムの UI リファレンス」を参照してください。
注意
Marketplace アイテムを正しく構築するには、4 つすべてのアイコン サイズ (小、中、大、ワイド) が必要です。
Manifest.json に対するその他の編集については、「リファレンス: Marketplace アイテム manifest.json」を参照してください。
ファイルの変更が終わったら、それを .azpkg ファイルに変換します。 変換は、AzureGallery.exe ツールと、前にダウンロードしたサンプル ギャラリー パッケージを使用して実行します。 次のコマンドを実行します。
.\AzureStackHubGallery.exe package -m c:\<path>\<gallery package name>\manifest.json -o c:\TempNote
出力パスは任意のパスを指定でき、C: ドライブの下でなくてもかまいません。 ただし、manifest.json ファイルと出力パッケージ両方への完全なパスが存在している必要があります。 たとえば、出力パスが
C:\<path>\galleryPackageName.azpkgの場合、フォルダーC:\<path>が存在している必要があります。
Marketplace アイテムの発行
PowerShell または Azure Storage Explorer を使用して、Marketplace アイテム (.azpkg) を Azure Blob Storage にアップロードします。 ローカルの Azure Stack Hub ストレージにアップロードすることも、パッケージの一時的な場所である Azure Storage にアップロードすることもできます。 BLOB がパブリックにアクセスできることを確認します。
ギャラリー パッケージを Azure Stack Hub にインポートするには、まずクライアント VM にリモート接続 (RDP) して、お使いの Azure Stack Hub に作成したばかりのファイルをコピーします。
コンテキストを追加します。
$ArmEndpoint = "https://adminmanagement.local.azurestack.external" Add-AzEnvironment -Name "AzureStackAdmin" -ArmEndpoint $ArmEndpoint Connect-AzAccount -EnvironmentName "AzureStackAdmin"次のスクリプトを実行して、リソースをギャラリーにインポートします。
Add-AzsGalleryItem -GalleryItemUri ` https://sample.blob.core.windows.net/<temporary blob name>/<offerName.publisherName.version>.azpkg -VerboseAdd-AzsGalleryItem の実行時にエラーが発生した場合、
gallery.adminモジュールの 2 つのバージョンがインストールされている可能性があります。 モジュールのすべてのバージョンを削除し、最新バージョンをインストールしてください。 PowerShell モジュールをアンインストールする手順については、「既存のバージョンの Azure Stack Hub PowerShell モジュールをアンインストールする」を参照してください。アイテムの格納に使用できる有効なストレージ アカウントがあることを確認します。
GalleryItemURIの値は、Azure Stack Hub 管理者ポータルから取得できます。 [ストレージ アカウント] -> [BLOB のプロパティ] -> [URL] の順に選択し、拡張子を .azpkg にします。 ストレージ アカウントは、Marketplace に発行するために一時的に使用するためのものです。ギャラリー パッケージが完成し、Add-AzsGalleryItem を使用してアップロードすると、カスタム VM が Marketplace と [リソースの作成] ビューに表示されるようになります。 Marketplace の管理にはカスタム ギャラリー パッケージが表示されないことに注意してください。
アイテムが Marketplace に正常に発行されたら、ストレージ アカウントからコンテンツを削除できます。
すべての既定のギャラリー アイテムと、カスタムのギャラリー アイテムは、次の URL での認証を使用せずにアクセスできるようになりました。
https://galleryartifacts.adminhosting.[Region].[externalFQDN]/artifact/20161101/[TemplateName]/DeploymentTemplates/Template.jsonhttps://galleryartifacts.hosting.[Region].[externalFQDN]/artifact/20161101/[TemplateName]/DeploymentTemplates/Template.json
Marketplace アイテムを削除するには、Remove-AzGalleryItem コマンドレットを使用します。 次に例を示します。
Remove-AzsGalleryItem -Name <Gallery package name> -Verbose
注意
アイテムを削除した後に Marketplace UI でエラーが表示される可能性があります。 このエラーを解決するには、ポータルで [設定] をクリックします。 次に、 [ポータルのカスタマイズ] で [変更を破棄する] を選択します。
リファレンス: Marketplace アイテム manifest.json
ID 情報
| 名前 | 必須 | Type | 制約 | 説明 |
|---|---|---|---|---|
| 名前 | X | String | [A-Za-z0-9]+ | |
| Publisher | X | String | [A-Za-z0-9]+ | |
| Version | X | String | SemVer v2 |
Metadata
| 名前 | 必須 | Type | 制約 | 説明 |
|---|---|---|---|---|
| DisplayName | X | String | 推奨 80 文字 | 項目名が 80 文字より長い場合、ポータルで適切に表示されないことがあります。 |
| PublisherDisplayName | X | String | 推奨 30 文字 | 発行元の名前が 30 文字より長い場合、ポータルで適切に表示されないことがあります。 |
| PublisherLegalName | X | String | 最大 256 文字 | |
| まとめ | X | String | 60 ～ 100 文字 | |
| LongSummary | X | String | 140 ～ 256 文字 | 現在はまだ Azure Stack Hub には該当しません。 |
| 説明 | X | HTML | 500 ～ 5,000 文字 |
イメージ
Marketplace では、次のアイコンを使用します。
| 名前 | 幅 | [高さ] | Notes |
|---|---|---|---|
| Wide | 255 px | 115 px | 常に必要 |
| Large | 115 px | 115 px | 常に必要 |
| Medium | 90 px | 90 px | 常に必要 |
| Small | 40 px | 40 px | 常に必要 |
| Screenshot | 533 px | 324 px | 省略可能 |
Categories
Marketplace の各アイテムは、そのアイテムのポータル UI における表示場所を識別するカテゴリでタグ付けする必要があります。 Azure Stack Hub 内の既存のカテゴリのいずれか ( [コンピューティング] 、 [データ + ストレージ] など) を選択するか、新しいものを選択します。
リンク
各 Marketplace アイテムには、追加コンテンツへのさまざまなリンクを含めることができます。 これらのリンクは、次の名前と URI の一覧として指定されます。
| 名前 | 必須 | Type | 制約 | 説明 |
|---|---|---|---|---|
| DisplayName | X | String | 最大 64 文字。 | |
| Uri | X | URI |
追加のプロパティ
前述のメタデータに加えて、Marketplace 作成者は次の形式でカスタムのキー/値のペアでデータを指定することができます。
| 名前 | 必須 | Type | 制約 | 説明 |
|---|---|---|---|---|
| DisplayName | X | String | 最大 25 文字。 | |
| 値 | X | String | 最大 30 文字。 |
HTML のサニタイズ
HTML を許可するフィールドでは、次の要素と属性を使用できます。
h1, h2, h3, h4, h5, p, ol, ul, li, a[target|href], br, strong, em, b, i
リファレンス: Marketplace アイテムの UI
Azure Stack Hub ポータルに表示される Marketplace アイテムのアイコンとテキストは、次のとおりです。
[作成] ブレード
![[作成] ブレード - Azure Stack Hub の Marketplace アイテム](media/azure-stack-create-and-publish-marketplace-item/image1.png?view=azs-2301)
[Marketplace item details (Marketplace アイテムの詳細)] ブレード
![Azure Stack Hub の [Marketplace item details (Marketplace アイテムの詳細)] ブレード](media/azure-stack-create-and-publish-marketplace-item/image3.png?view=azs-2301)