You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: azure-stack/operator/azure-stack-add-vm-image.md
+21-26Lines changed: 21 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
---
2
2
title: Add a custom VM image to Azure Stack Hub
3
-
description: Learn how to add or remove a custom VM image to Azure Stack Hub.
3
+
description: Learn how to add or remove a custom VM image to or from Azure Stack Hub.
4
4
author: sethmanheim
5
5
ms.topic: how-to
6
-
ms.date: 07/21/2021
6
+
ms.date: 08/15/2024
7
7
ms.author: sethm
8
8
ms.reviewer: unknown
9
9
ms.lastreviewed: 9/8/2020
@@ -18,19 +18,19 @@ ms.lastreviewed: 9/8/2020
18
18
In Azure Stack Hub, as an operator you can add your custom virtual machine (VM) image to the marketplace and make it available to your users. You can add VM images to the Azure Stack Hub Marketplace through the administrator portal or Windows PowerShell. Use either an image from global Microsoft Azure Marketplace as a base for your custom image, or create your own using Hyper-V.
19
19
20
20
> [!NOTE]
21
-
> Blob access is required to allow the read access.
21
+
> Blob access is required to allow the read access.
22
22
23
23
## Add an image
24
24
25
-
You can find instructions for adding generalized and specialized images in the **Compute** section of the user guide. You will want to create a generalized image before offering the image to your users. For instructions, see [Move a VM to Azure Stack Hub Overview](../user/vm-move-overview.md). When creating images available for your tenants, use the Azure Stack Hub administrative portal or administrator endpoints rather than the user portal or tenant directory endpoints.
25
+
You can find instructions for adding generalized and specialized images in the **Compute** section of the user guide. You must create a generalized image before offering the image to your users. For instructions, see [Move a VM to Azure Stack Hub overview](../user/vm-move-overview.md). When you create images and make them available for your tenants, use the Azure Stack Hub administrator portal or administrator endpoints, rather than the user portal or tenant directory endpoints.
26
26
27
27
You have two options for making an image available to your users:
28
28
29
29
-**Offer an image only accessible via Azure Resource Manager**
30
-
If you add the image via the Azure Stack Hub administrative portal in **Compute** > **Images**, all of your tenants can access the image. However your users will need to use an Azure Resource Manager template to access it. It won't be visible in your Azure Stack Hub Marketplace.
30
+
If you add the image via the Azure Stack Hub administrator portal in **Compute > Images**, all of your tenants can access the image. However, your users need to use an Azure Resource Manager template to access it. It won't be visible in your Azure Stack Hub Marketplace.
31
31
32
32
-**Offer an image through the Azure Stack Hub Marketplace**
33
-
Once you have added your image through the Azure Stack Hub administrative portal, you can then create a marketplace offering. For instructions, see [Create and publish a custom Azure Stack Hub Marketplace item](azure-stack-create-and-publish-marketplace-item.md).
33
+
Once you add your image through the Azure Stack Hub administrator portal, you can then create a marketplace offering. For instructions, see [Create and publish a custom Azure Stack Hub Marketplace item](azure-stack-create-and-publish-marketplace-item.md).
34
34
35
35
## Add a platform image
36
36
@@ -42,31 +42,31 @@ Add a VM image as an Azure Stack Hub operator using the portal.
42
42
43
43
1. Sign in to Azure Stack Hub as an operator. Select **Dashboard** from the left-hand navigation.
44
44
45
-
2. In the **Resource providers** list, select **Compute**.
45
+
1. In the **Resource providers** list, select **Compute**.
[](./media/azure-stack-add-vm-image/tca4.png#lightbox)
52
52
53
-
4. Under **Create image**, enter the **Publisher**, **Offer**, **SKU**, **Version**, and OS disk blob URI. Then, select **Create** to begin creating the VM image.
53
+
1. Under **Create image**, enter the **Publisher**, **Offer**, **SKU**, **Version**, and OS disk blob URI. Then, select **Create** to begin creating the VM image.
When the image is successfully created, the VM image status changes to **Succeeded**.
58
58
59
-
5. When you add an image, it is only available for Azure Resource Manager-based templates and PowerShell deployments. To make an image available to your users as a marketplace item, publish the marketplace item using the steps in the article [Create and publish a Marketplace item](azure-stack-create-and-publish-marketplace-item.md). Make sure you note the **Publisher**, **Offer**, **SKU**, and **Version** values. You will need them when you edit the Resource Manager template and Manifest.json in your custom .azpkg.
59
+
1. When you add an image, it's only available for Azure Resource Manager-based templates and PowerShell deployments. To make an image available to your users as a marketplace item, publish the marketplace item using the steps in the article [Create and publish a Marketplace item](azure-stack-create-and-publish-marketplace-item.md). Make sure you note the **Publisher**, **Offer**, **SKU**, and **Version** values. You need them when you edit the Resource Manager template and Manifest.json in your custom .azpkg.
60
60
61
61
### [PowerShell](#tab/image-add-ps)
62
62
63
-
Add a VM image as an Azure Stack Hub operator using PowerShell.
63
+
Add a VM image as an Azure Stack Hub operator using PowerShell:
64
64
65
65
1.[Install PowerShell for Azure Stack Hub](azure-stack-powershell-install.md).
66
66
67
-
2.[Sign in to Azure Stack Hub as an operator](azure-stack-powershell-configure-admin.md).
67
+
1.[Sign in to Azure Stack Hub as an operator](azure-stack-powershell-configure-admin.md).
68
68
69
-
3. Open PowerShell with an elevated prompt, and run:
69
+
1. Open PowerShell in an elevated prompt, and run:
70
70
71
71
```powershell
72
72
Add-AzsPlatformimage -publisher "<publisher>" `
@@ -77,7 +77,7 @@ Add a VM image as an Azure Stack Hub operator using the portal.
77
77
-OSUri "<OS URI>"
78
78
```
79
79
80
-
The **Add-AzsPlatformimage** cmdlet specifies values used by the Azure Resource Manager templates to reference the VM image. The values include:
80
+
The **Add-AzsPlatformimage** cmdlet specifies values used by the Azure Resource Manager templates to reference the VM image. These values include:
81
81
-**publisher**
82
82
For example: `Canonical`
83
83
The **publisher** name segment of the VM image that users use when they deploy the image. Don't include a space or other special characters in this field.
@@ -99,7 +99,7 @@ Add a VM image as an Azure Stack Hub operator using the portal.
99
99
100
100
For more information, see the PowerShell reference for the [Add-AzsPlatformimage](/powershell/module/azs.compute.admin/add-azsplatformimage) cmdlet.
101
101
102
-
4. When you add an image, it is only available for Azure Resource Manager-based templates and PowerShell deployments. To make an image available to your users as a marketplace item, publish the marketplace item using the steps in the article [Create and publish a Marketplace item](azure-stack-create-and-publish-marketplace-item.md). Make sure you note the **Publisher**, **Offer**, **SKU**, and **Version** values. You will need them when you edit the Resource Manager template and Manifest.json in your custom .azpkg.
102
+
1. When you add an image, it's only available for Azure Resource Manager-based templates and PowerShell deployments. To make an image available to your users as a marketplace item, publish the marketplace item using the steps in the article [Create and publish a Marketplace item](azure-stack-create-and-publish-marketplace-item.md). Make sure you note the **Publisher**, **Offer**, **SKU**, and **Version** values. You need them when you edit the Resource Manager template and Manifest.json in your custom .azpkg.
103
103
104
104
---
105
105
@@ -112,22 +112,17 @@ You can remove a platform image using the portal or PowerShell.
112
112
To remove the VM image as an Azure Stack Hub operator using the Azure Stack Hub portal, follow these steps:
113
113
114
114
1. Open the Azure Stack Hub [administrator portal](https://portal.azure.com/signin/index).
115
-
116
-
2. If the VM image has an associated Marketplace item, select **Marketplace management**, and then select the VM marketplace item you want to delete.
117
-
118
-
3. If the VM image does not have an associated Marketplace item, navigate to **All services > Compute > VM Images**, and then select the ellipsis (**...**) next to the VM image.
119
-
120
-
4. Select **Delete**.
115
+
1. If the VM image has an associated Marketplace item, select **Marketplace management**, and then select the VM marketplace item you want to delete.
116
+
1. If the VM image doesn't have an associated Marketplace item, navigate to **All services > Compute > VM Images**, and then select the ellipsis (**...**) next to the VM image.
117
+
1. Select **Delete**.
121
118
122
119
### [PowerShell](#tab/image-rem-ps)
123
120
124
121
To remove the VM image as an Azure Stack Hub operator using PowerShell, follow these steps:
125
122
126
123
1.[Install PowerShell for Azure Stack Hub](azure-stack-powershell-install.md).
127
-
128
-
2.[Sign in to Azure Stack Hub as an operator](azure-stack-powershell-configure-admin.md).
129
-
130
-
3. Open PowerShell with an elevated prompt, and run:
124
+
1.[Sign in to Azure Stack Hub as an operator](azure-stack-powershell-configure-admin.md).
125
+
1. Open PowerShell in an elevated prompt, and run:
131
126
132
127
```powershell
133
128
Remove-AzsPlatformImage `
@@ -151,7 +146,7 @@ To remove the VM image as an Azure Stack Hub operator using PowerShell, follow t
151
146
For example: `1.0.0`
152
147
The version of the VM image that users use when they deploy the VM image. This version is in the format **\#.\#.\#**. Don't include a space or other special characters in this field.
153
148
154
-
For more info about the **Remove-AzsPlatformImage** cmdlet, see the Microsoft PowerShell [Azure Stack Hub Operator module documentation](/powershell/azurestackhub/overview).
149
+
For more information about the **Remove-AzsPlatformImage** cmdlet, see the Microsoft PowerShell [Azure Stack Hub Operator module documentation](/powershell/azurestackhub/overview).
0 commit comments