Skip to content

Commit 77a04ad

Browse files
authored
Added list of features for new API 2024-02-01 in changelog
1 parent 5d54915 commit 77a04ad

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

articles/virtual-machines/image-builder-api-update-release-notes.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ This article contains all major API changes and feature updates for the Azure VM
2323

2424
Starting from May 21, 2024, Azure VM Image Builder's API version 2024-02-01 and beyond will enforce case sensitivity for all fields. This means that the capitalization of letters in your API requests must match exactly with the expected format.
2525

26+
>[!IMPORTANT]
2627
> **Important Note for Existing Azure Image Builder Users**
2728
>
2829
> If you're an existing user of Azure VM Image Builder, rest assured that this change will **not** impact your existing resources. The case sensitivity enforcement applies only to **newly created resources** using **API version 2024-02-01 and beyond**. Your existing resources will continue to function as expected without any changes.
@@ -37,7 +38,8 @@ If you send an API request to Azure Image Builder's API version 2024-02-01 and b
3738

3839
The error message will mention an "unknown field" and direct you to the official documentation: [Create an Azure Image Builder Bicep or ARM template JSON template](./linux/image-builder-json.md).
3940

40-
> **Reference Azure Image Builder's Swagger for API Calls**
41+
> [!NOTE]
42+
> **Reference Azure Image Builder's Swagger for API Calls**
4143
>
4244
> When making calls to the Azure Image Builder service, always reference the [Swagger documentation](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable), which serves as the definitive source of truth for Azure Image Builder's API specifications. While the public documentation has been updated to include the proper capitalization and field names ahead of the API release, the Swagger definition contains precise details about each AIB API to ensure you are making calls to the service correctly.
4345
@@ -108,7 +110,7 @@ New-AzResourceGroupDeployment -ResourceGroupName <resourceGroupName> -TemplateFi
108110
### November 2023
109111
Azure Image Builder is enabling Isolated Image Builds using Azure Container Instances in a phased manner. The rollout is expected to be completed by early 2024. Your existing image templates will continue to work and there is no change in the way you create or build new image templates.
110112

111-
You might observe a different set of transient Azure resources appear temporarily in the staging resource group but that does not impact your actual builds or the way you interact with Azure Image Builder. For more information, please see [Isolated Image Builds](./security-isolated-image-builds-image-builder.md).
113+
You might observe a different set of transient Azure resources appear temporarily in the staging resource group but that does not impact your actual builds or the way you interact with Azure Image Builder. For more information, see [Isolated Image Builds](./security-isolated-image-builds-image-builder.md).
112114

113115
> [!IMPORTANT]
114116
>Make sure your subscription is registered for the `Microsoft.ContainerInstance` provider and there are no policies blocking deployment of Azure Container Instances resources. Also ensure that quota is available for Azure Container Instances resources.
@@ -118,6 +120,25 @@ New portal functionality has been added for Azure Image Builder. Search “Image
118120

119121
## API releases
120122

123+
### Version 2024-02-01
124+
125+
**Improvements**
126+
- New `autoRun` property which allows you to run the image template build on template creation or update.
127+
- New `managedResourceTags` property which allows you to apply tags to the resource group and/or resources created by the Azure VM Image Builder service.
128+
- New `containerInstanceSubnetId` property which allows you to specify a pre-existing subnet on which the build VM and validation VM will be deployed. For more information, see [
129+
Bring your own Build VM subnet and bring your own ACI subnet](./security-isolated-image-builds-image-builder.md#bring-your-own-build-vm-subnet-and-bring-your-own-ACI-subnet).
130+
- Added support for updating the `vmProfile` property including the following fields:
131+
- `vmSize`
132+
- `osDiskSizeGB`
133+
- `userAssignedIdentities`
134+
- `vnetConfig`
135+
- `subnetId`
136+
- `containerInstanceSubnetId`
137+
For more information on the `vmProfile` property, see [vmProfile](../virtual-machines/linux/image-builder-json.md#properties-vmprofile).
138+
139+
**Changes**
140+
API version 2024-02-01 introduces a breaking change that enforces case sensitivity for all fields. This means that the capitalization of letters in your API requests must match exactly with the expected format. If you send an API request to Azure Image Builder's API version 2024-02-01 and beyond with incorrect case or unrecognized fields, the service will reject it. You will receive an error response indicating that the request is invalid. For more information, see [Breaking Change: Case Sensitivity](#may-2024).
141+
121142
### Version 2023-07-01
122143

123144
**Coming Soon**

0 commit comments

Comments
 (0)