Skip to content

Commit 8f8ea1e

Browse files
authored
Update batch-sig-images.md
1. Change that we only support first party base image to Azure Batch supported Marketplace images; 2. Delete deprecated API reference "List node agent SKUs"; 3. Move "Create an Azure Compute Gallery section forward", which is the correct step. Customer need gallery creation first and then image can be added in this gallery; 4. Add reference "To create an image requires purchase plan", and add how to check whether the image has correct plan information references.
1 parent e153ac3 commit 8f8ea1e

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

articles/batch/batch-sig-images.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Use the Azure Compute Gallery to create a custom image pool
33
description: Custom image pools are an efficient way to configure compute nodes to run your Batch workloads.
44
ms.topic: conceptual
5-
ms.date: 11/09/2023
5+
ms.date: 03/04/2024
66
ms.devlang: csharp
77
# ms.devlang: csharp, python
88
ms.custom: devx-track-python, devx-track-azurecli, linux-related-content
@@ -65,17 +65,13 @@ The following steps show how to prepare a VM, take a snapshot, and create an ima
6565

6666
### Prepare a VM
6767

68-
If you're creating a new VM for the image, use a first party Azure Marketplace image supported by Batch as the base image for your managed image. Only first party images can be used as a base image.
68+
If you're creating a new VM for the image, use Azure Marketplace image supported by Batch as the base image for your managed image.
6969

70-
To get a full list of current Azure Marketplace image references supported by Azure Batch, use one of the following APIs to return a list of Windows and Linux VM images including the node agent SKU IDs for each image:
70+
To get a full list of current Azure Marketplace image references supported by Azure Batch, use one of the following APIs to return a list of Windows and Linux VM images:
7171

7272
- PowerShell: [Azure Batch supported images](/powershell/module/az.batch/get-azbatchsupportedimage)
7373
- Azure CLI: [Azure Batch pool supported images](/cli/azure/batch/pool/supported-images)
7474
- Batch service APIs: [Batch service APIs](batch-apis-tools.md#batch-service-apis) and [Azure Batch service supported images](/rest/api/batchservice/account/listsupportedimages)
75-
- List node agent SKUs: [Node agent SKUs](/java/api/com.microsoft.azure.batch.protocol.accounts.listnodeagentskus)
76-
77-
> [!NOTE]
78-
> You can't use a third-party image that has additional license and purchase terms as your base image. For information about these Marketplace images, see the guidance for [Linux](../virtual-machines/linux/cli-ps-findimage.md#check-the-purchase-plan-information) or [Windows](../virtual-machines/windows/cli-ps-findimage.md#view-purchase-plan-properties)VMs.
7975

8076
Follow these guidelines when creating VMs:
8177

@@ -87,6 +83,10 @@ Follow these guidelines when creating VMs:
8783
- Once the VM is running, connect to it via RDP (for Windows) or SSH (for Linux). Install any necessary software or copy desired data.
8884
- For faster pool provisioning, use the [ReadWrite disk cache setting](../virtual-machines/premium-storage-performance.md#disk-caching) for the VM's OS disk.
8985

86+
### Create an Azure Compute Gallery
87+
88+
You need to create an Azure Compute Gallery to make your custom image available. Select this gallery when creating image in the following steps. To learn how to create an Azure Compute Gallery for your images, see [Create an Azure Compute Gallery](../virtual-machines/create-gallery.md).
89+
9090
### Create a VM snapshot
9191

9292
A snapshot is a full, read-only copy of a VHD. To create a snapshot of a VM's OS or data disks, you can use the Azure portal or command-line tools. For steps and options to create a snapshot, see the guidance for [VMs](../virtual-machines/snapshot-copy-managed-disk.md).
@@ -99,10 +99,14 @@ To create an image from a VM in the portal, see [Capture an image of a VM](../vi
9999

100100
To create an image using a source other than a VM, see [Create an image](../virtual-machines/image-version.md).
101101

102+
To create an image requires purchase plan, see [Supply Azure Marketplace purchase plan information when creating images](https://learn.microsoft.com/en-us/azure/virtual-machines/marketplace-images).
102103

103-
### Create an Azure Compute Gallery
104-
105-
Once you have successfully created your managed image, you need to create an Azure Compute Gallery to make your custom image available. To learn how to create an Azure Compute Gallery for your images, see [Create an Azure Compute Gallery](../virtual-machines/create-gallery.md).
104+
> [!NOTE]
105+
> If the base image requires purchase plan, Batch will need the required purchased image plan information when creating pools. You have to make sure that the image has the correct plan information when you create it.
106+
>
107+
> For the purchase plan information about these Marketplace images, see the guidance for [Linux](../virtual-machines/linux/cli-ps-findimage.md#check-the-purchase-plan-information) or [Windows](../virtual-machines/windows/cli-ps-findimage.md#view-purchase-plan-properties) VMs.
108+
>
109+
> Use Azure PowerShell [Get-AzGalleryImageDefinition](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azgalleryimagedefinition) or Azure CLI [az sig image-definition show](https://learn.microsoft.com/en-us/cli/azure/sig/image-definition?view=azure-cli-latest#az-sig-image-definition-show) to check whether the gallery image has correct plan information.
106110
107111
## Create a pool from a Shared Image using the Azure CLI
108112

0 commit comments

Comments
 (0)