Skip to content

Commit cf6d203

Browse files
implemented Acrolinx suggestions based on PR feedback
1 parent ca3bd16 commit cf6d203

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

articles/virtual-machines/linux/image-builder-json.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Create an Azure Image Builder Bicep file or ARM JSON template
3-
description: Learn how to create a Bicep file or ARM JSON template to use with Azure Image Builder.
2+
title: Create an Azure Image Builder Bicep file or ARM template JSON template
3+
description: Learn how to create a Bicep file or ARM template JSON template to use with Azure Image Builder.
44
author: kof-f
55
ms.author: kofiforson
66
ms.reviewer: erd
@@ -11,11 +11,11 @@ ms.subservice: image-builder
1111
ms.custom: references_regions, devx-track-bicep
1212
---
1313

14-
# Create an Azure Image Builder Bicep or ARM JSON template
14+
# Create an Azure Image Builder Bicep or ARM template JSON template
1515

1616
**Applies to:** :heavy_check_mark: Linux VMs :heavy_check_mark: Windows VMs :heavy_check_mark: Flexible scale sets
1717

18-
Azure Image Builder uses a Bicep file or an ARM JSON template file to pass information into the Image Builder service. In this article we'll go over the sections of the files, so you can build your own. For latest API versions, see [template reference](/azure/templates/microsoft.virtualmachineimages/imagetemplates?tabs=bicep&pivots=deployment-language-bicep). To see examples of full .json files, see the [Azure Image Builder GitHub](https://github.com/Azure/azvmimagebuilder/tree/main/quickquickstarts).
18+
Azure Image Builder uses a Bicep file or an ARM template JSON template file to pass information into the Image Builder service. In this article we go over the sections of the files, so you can build your own. For latest API versions, see [template reference](/azure/templates/microsoft.virtualmachineimages/imagetemplates?tabs=bicep&pivots=deployment-language-bicep). To see examples of full .json files, see the [Azure Image Builder GitHub](https://github.com/Azure/azvmimagebuilder/tree/main/quickquickstarts).
1919

2020
The basic format is:
2121

@@ -157,7 +157,7 @@ The location is the region where the custom image is created. The following regi
157157
> [!IMPORTANT]
158158
> Register the feature `Microsoft.VirtualMachineImages/MooncakePublicPreview` to access the Azure Image Builder public preview in the China North 3 region.
159159
160-
To access the Azure VM Image Builder public preview in the Fairfax regions (USGov Arizona and USGov Virginia), you must register the *Microsoft.VirtualMachineImages/FairfaxPublicPreview* feature. To do so, run the following command in either PowerShell or Azure CLI:
160+
To access the Azure VM Image Builder public preview in the Azure Government regions (USGov Arizona and USGov Virginia), you must register the *Microsoft.VirtualMachineImages/FairfaxPublicPreview* feature. To do so, run the following command in either PowerShell or Azure CLI:
161161

162162
### [Azure PowerShell](#tab/azure-powershell)
163163

@@ -305,7 +305,7 @@ To learn more, see:
305305

306306
Maximum duration to wait while building the image template (includes all customizations, validations, and distributions).
307307

308-
If you don't specify the property or set the value to 0, the default value is used, which is 240 minutes or four hours. The minimum value is 6 minutes, and the maximum value is 960 minutes or 16 hours. When the timeout value is hit (whether or not the image build is complete), you'll see an error similar to:
308+
If you don't specify the property or set the value to 0, the default value is used, which is 240 minutes or four hours. The minimum value is 6 minutes, and the maximum value is 960 minutes or 16 hours. When the timeout value is hit (whether or not the image build is complete), you see an error similar to:
309309

310310
```text
311311
[ERROR] Failed while waiting for packerizer: Timeout waiting for microservice to
@@ -939,7 +939,7 @@ replicationRegions: [
939939
940940
#### Distribute: targetRegions
941941

942-
The following JSON is an example of how to use the targetRegions field to distribute to a Azure Compute Gallery.
942+
The following JSON is an example of how to use the targetRegions field to distribute to an Azure Compute Gallery.
943943

944944
# [JSON](#tab/json)
945945
```json
@@ -1008,12 +1008,12 @@ Distribute properties for galleries:
10081008
- **runOutputName** – unique name for identifying the distribution.
10091009
- **artifactTags** - optional user specified key\value tags.
10101010
- **replicationRegions** - array of regions for replication. One of the regions must be the region where the Gallery is deployed. Adding regions mean an increase of build time, as the build doesn't complete until the replication has completed. This field is deprecated as of API version 2022-07-01, please use `targetRegions` when distributing a "SharedImage" type.
1011-
- **targetRegions** - an array of regions for replication. It is newly introduced as part of the [2022-07-01 API](../../virtual-machines/image-builder-api-update-release-notes.md#version-2022-07-01) and applies only to the `SharedImage` type distribute.
1011+
- **targetRegions** - an array of regions for replication. It's newly introduced as part of the [2022-07-01 API](../../virtual-machines/image-builder-api-update-release-notes.md#version-2022-07-01) and applies only to the `SharedImage` type distribute.
10121012
- **excludeFromLatest** (optional) - allows you to mark the image version you create not be used as the latest version in the gallery definition, the default is 'false'.
10131013
- **storageAccountType** (optional) - AIB supports specifying these types of storage for the image version that is to be created:
10141014

10151015
- "Standard_LRS"
1016-
- "Standard_ZRS"","
1016+
- "Standard_ZRS","
10171017

10181018

10191019
> [!NOTE]
@@ -1024,7 +1024,7 @@ Distribute properties for galleries:
10241024

10251025
## versioning
10261026

1027-
The **versioning** property is for the `sharedImage` distribute type only. It is an enum with two possible values:
1027+
The **versioning** property is for the `sharedImage` distribute type only. It's an enum with two possible values:
10281028
- **latest** - New strictly increasing schema per design
10291029
- **source** - Schema based upon the version number of the source image.
10301030

@@ -1144,7 +1144,7 @@ VHD distribute properties:
11441144

11451145
## Properties: source
11461146

1147-
The `source` section contains information about the source image that will be used by Image Builder. Azure Image Builder only supports generalized images as source images, specialized images are not supported at this time.
1147+
The `source` section contains information about the source image that will be used by Image Builder. Azure Image Builder only supports generalized images as source images, specialized images aren't supported at this time.
11481148

11491149
The API requires a `SourceType` that defines the source for the image build, currently there are three types:
11501150

@@ -1288,7 +1288,7 @@ source: {
12881288
```
12891289

12901290
---
1291-
- imageVersionId - ARM resource id of the image version. When image version name is 'latest', the version is evaluated when the image build takes place. The `imageVersionId` should be the `ResourceId` of the image version. Use [az sig image-version list](/cli/azure/sig/image-version#az-sig-image-version-list) to list image versions.
1291+
- imageVersionId - ARM template resource ID of the image version. When image version name is 'latest', the version is evaluated when the image build takes place. The `imageVersionId` should be the `ResourceId` of the image version. Use [az sig image-version list](/cli/azure/sig/image-version#az-sig-image-version-list) to list image versions.
12921292

12931293

12941294
The following JSON sets the source image as an image stored in a [Direct Shared Gallery](/azure/virtual-machines/shared-image-galleries?tabs=azure-cli#sharing).
@@ -1342,7 +1342,7 @@ properties: {
13421342

13431343
SharedImageVersion properties:
13441344

1345-
**imageVersionId** - ARM resource id of the image version. When the image version name is 'latest', the version is evaluated when the image build takes place.
1345+
**imageVersionId** - ARM template resource ID of the image version. When the image version name is 'latest', the version is evaluated when the image build takes place.
13461346

13471347

13481348
## Properties: stagingResourceGroup
@@ -1610,7 +1610,7 @@ By default, Image Builder doesn't change the size of the image, it uses the size
16101610

16111611
### vnetConfig (optional)
16121612

1613-
If you don't specify any VNet properties, Image Builder will create its own VNet, Public IP, and network security group (NSG). The Public IP is used for the service to communicate with the build VM. If you don't want to have a Public IP or you want Image Builder to have access to your existing VNet resources, such as configuration servers (DSC, Chef, Puppet, Ansible), file shares, then you can specify a VNet. For more information, review the [networking documentation](image-builder-networking.md).
1613+
If you don't specify any VNet properties, Image Builder creates its own VNet, Public IP, and network security group (NSG). The Public IP is used for the service to communicate with the build VM. If you don't want to have a Public IP or you want Image Builder to have access to your existing VNet resources, such as configuration servers (DSC, Chef, Puppet, Ansible), file shares, then you can specify a VNet. For more information, review the [networking documentation](image-builder-networking.md).
16141614

16151615
# [JSON](#tab/json)
16161616

0 commit comments

Comments
 (0)