vmss: support for passing a health probe to update #7355

tombuildsstuff · 2019-09-28T06:15:39Z

The Update struct for a Virtual Machine Scale Set doesn't currently expose the 'HealthProbe' block required when updating a VMSS with an Automatic/Rolling Upgrade Policy using the Update method:

{
	"properties": {
		"upgradePolicy": {
			"mode": "Rolling",
			"rollingUpgradePolicy": {
				"maxBatchInstancePercent": 21,
				"maxUnhealthyInstancePercent": 22,
				"maxUnhealthyUpgradedInstancePercent": 23,
				"pauseTimeBetweenBatches": "PT30S"
			}
		},
		"virtualMachineProfile": {
			"storageProfile": {
				"imageReference": {
					"publisher": "Canonical",
					"offer": "UbuntuServer",
					"sku": "18.04-LTS",
					"version": "latest"
				}
			},
			"networkProfile": {
				"networkInterfaceConfigurations": [{
					"name": "example",
					"properties": {
						"primary": true,
						"enableAcceleratedNetworking": false,
						"dnsSettings": {
							"dnsServers": []
						},
						"ipConfigurations": [{
							"name": "internal",
							"properties": {
								"subnet": {
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/virtualNetworks/acctestnw-190928080303507041/subnets/internal"
								},
								"primary": true,
								"privateIPAddressVersion": "IPv4",
								"applicationGatewayBackendAddressPools": [],
								"applicationSecurityGroups": [],
								"loadBalancerBackendAddressPools": [{
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/backendAddressPools/test"
								}],
								"loadBalancerInboundNatPools": [{
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/inboundNatPools/test"
								}]
							}
						}],
						"enableIPForwarding": false
					}
				}]
			}
		}
	}
}

which currently returns:

{
	"error": {
		"code": "BadRequest",
		"message": "Rolling Upgrade mode is not supported for this Virtual Machine Scale Set because a health probe or health extension was not provided."
	}
}

This PR adds the HealthProbe block to the Update object, which when specified allows the Update to complete successfully:

{
	"properties": {
		"upgradePolicy": {
			"mode": "Rolling",
			"rollingUpgradePolicy": {
				"maxBatchInstancePercent": 21,
				"maxUnhealthyInstancePercent": 22,
				"maxUnhealthyUpgradedInstancePercent": 23,
				"pauseTimeBetweenBatches": "PT30S"
			}
		},
		"virtualMachineProfile": {
			"storageProfile": {
				"imageReference": {
					"publisher": "Canonical",
					"offer": "UbuntuServer",
					"sku": "18.04-LTS",
					"version": "latest"
				}
			},
			"networkProfile": {
				"healthProbe": {
					"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/probes/acctest-lb-probe"
				},
				"networkInterfaceConfigurations": [{
					"name": "example",
					"properties": {
						"primary": true,
						"enableAcceleratedNetworking": false,
						"dnsSettings": {
							"dnsServers": []
						},
						"ipConfigurations": [{
							"name": "internal",
							"properties": {
								"subnet": {
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/virtualNetworks/acctestnw-190928080303507041/subnets/internal"
								},
								"primary": true,
								"privateIPAddressVersion": "IPv4",
								"applicationGatewayBackendAddressPools": [],
								"applicationSecurityGroups": [],
								"loadBalancerBackendAddressPools": [{
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/backendAddressPools/test"
								}],
								"loadBalancerInboundNatPools": [{
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/inboundNatPools/test"
								}]
							}
						}],
						"enableIPForwarding": false
					}
				}]
			}
		}
	}
}

which then returns:

{
	"name": "acctestvmss-190928080303507041",
	"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Compute/virtualMachineScaleSets/acctestvmss-190928080303507041",
	"type": "Microsoft.Compute/virtualMachineScaleSets",
	"location": "westeurope",
	"tags": {},
	"sku": {
		"name": "Standard_F2",
		"tier": "Standard",
		"capacity": 0
	},
	"properties": {
		"singlePlacementGroup": true,
		"upgradePolicy": {
			"mode": "Rolling",
			"rollingUpgradePolicy": {
				"maxBatchInstancePercent": 21,
				"maxUnhealthyInstancePercent": 22,
				"maxUnhealthyUpgradedInstancePercent": 23,
				"pauseTimeBetweenBatches": "PT30S"
			}
		},
		"virtualMachineProfile": {
			"osProfile": {
				"computerNamePrefix": "acctestvmss-190928080303507041",
				"adminUsername": "adminuser",
				"linuxConfiguration": {
					"disablePasswordAuthentication": false,
					"ssh": {
						"publicKeys": []
					},
					"provisionVMAgent": true
				},
				"secrets": [],
				"allowExtensionOperations": true,
				"requireGuestProvisionSignal": true
			},
			"storageProfile": {
				"osDisk": {
					"createOption": "FromImage",
					"caching": "ReadWrite",
					"writeAcceleratorEnabled": false,
					"managedDisk": {
						"storageAccountType": "Standard_LRS"
					}
				},
				"imageReference": {
					"publisher": "Canonical",
					"offer": "UbuntuServer",
					"sku": "18.04-LTS",
					"version": "latest"
				}
			},
			"networkProfile": {
				"healthProbe": {
					"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/probes/acctest-lb-probe"
				},
				"networkInterfaceConfigurations": [{
					"name": "example",
					"properties": {
						"primary": true,
						"enableAcceleratedNetworking": false,
						"dnsSettings": {
							"dnsServers": []
						},
						"enableIPForwarding": false,
						"ipConfigurations": [{
							"name": "internal",
							"properties": {
								"primary": true,
								"subnet": {
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/virtualNetworks/acctestnw-190928080303507041/subnets/internal"
								},
								"privateIPAddressVersion": "IPv4",
								"loadBalancerBackendAddressPools": [{
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/backendAddressPools/test"
								}],
								"loadBalancerInboundNatPools": [{
									"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/acctestrg-190928080303507041/providers/Microsoft.Network/loadBalancers/acctestlb-190928080303507041/inboundNatPools/test"
								}]
							}
						}]
					}
				}]
			},
			"diagnosticsProfile": {
				"bootDiagnostics": {
					"enabled": false
				}
			},
			"priority": "Regular"
		},
		"provisioningState": "Updating",
		"overprovision": false,
		"doNotRunExtensionsOnOverprovisionedVMs": false,
		"uniqueId": "9e2399ba-dc3a-4307-bef5-d2a423a50ecd"
	}
}

openapi-sdkautomation · 2019-09-28T06:15:42Z

In Testing, Please Ignore

[Logs] (Generated from 5b6736a, Iteration 1)

.NET: test-repo-billy/azure-sdk-for-net [Logs] [Diff]

Microsoft.Azure.Management.Compute [Logs] [Instructions] [Generation PR]
- Microsoft.Azure.Management.Compute.29.1.0.nupkg
- Microsoft.Azure.Management.Compute.29.1.0.snupkg

Python: test-repo-billy/azure-sdk-for-python [Logs] [Diff]

azure-mgmt-compute [Logs] [Instructions] [Generation PR]
- azure-mgmt-compute-8.0.0.zip
- azure_mgmt_compute-8.0.0-py2.py3-none-any.whl

Java: test-repo-billy/azure-sdk-for-java [Logs] [Diff]

compute/resource-manager/v2017_03_30 [Logs] [Generation PR]
compute/resource-manager/v2017_09_01 [Logs]
compute/resource-manager/v2017_12_01 [Logs]
compute/resource-manager/v2018_04_01 [Logs]

JavaScript: test-repo-billy/azure-sdk-for-js [Logs] [Diff]

@azure/arm-compute [Logs] [Instructions] [Generation PR]
- azure-arm-compute-11.0.0.tgz

Go: test-repo-billy/azure-sdk-for-go [Logs] [Diff]

compute/mgmt/2015-06-15 [Logs]
compute/mgmt/2016-03-30 [Logs]
compute/mgmt/2017-03-30 [Logs]
compute/mgmt/2017-09-01 [Logs]
compute/mgmt/2017-12-01 [Logs]
compute/mgmt/2018-04-01 [Logs]
compute/mgmt/2018-06-01 [Logs]
compute/mgmt/2018-10-01 [Logs]
compute/mgmt/2019-03-01 [Logs]
compute/mgmt/2019-07-01 [Logs]
containerservice/mgmt/2016-03-30 [Logs]
containerservice/mgmt/2016-09-30 [Logs]
containerservice/mgmt/2017-01-31 [Logs]
preview/compute/mgmt/2016-04-30-preview [Logs]
preview/containerservice/mgmt/2015-11-01-preview [Logs]

Ruby: test-repo-billy/azure-sdk-for-ruby [Logs] [Diff]

azure_sdk [Logs] [Instructions]
- azure_sdk-0.19.7.gem

AutorestCI · 2019-09-28T06:18:50Z

Automation for azure-sdk-for-python

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
Azure/azure-sdk-for-python#7759

AutorestCI · 2019-09-28T06:22:03Z

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#5922

azuresdkci · 2019-09-28T07:00:31Z

Can one of the admins verify this patch?

ryansbenson · 2019-09-30T21:28:41Z

specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json

@@ -8435,6 +8435,10 @@
    },
    "VirtualMachineScaleSetUpdateNetworkProfile": {
      "properties": {
+        "healthProbe": {


This is a breaking change, please include this in a new api version

See 'New property added to response':
https://microsoft.sharepoint.com/:w:/t/azureresourcemanagerteam/EWXsAQ1yx25KkyYCeeWGUgwBSBxEdUDEbHi6FZ__U8EOQw?e=xEcppo

@ryansbenson this is in the existing API version - it's just missing from the Swagger - please see the examples in the PR description

In addition it appears that link isn't publicaly available:

@ryansbenson since this is already in the API (but is just missing from the Swagger) I'm assuming adding this optional property to an update (to match the API definition) should be fine?

Hi @tombuildsstuff for your information, the doc above lists various types of breaking changes, which contains on entry of

New property added to response If a new property/field is added to the response an API, the GET-PUT pipeline will be broken. Consider the case where from portal a customer updates the value of a new property "A". Another customer does a GET of this resource using the SDK. The SDK will ignore the property since it does not understand it. From the SDK, the customer does a PUT using the model that was returned from the GET. This will overwrite the change made by the first customer from the portal.

Per this entry, the addition of this property is a breaking change to the existing swagger.

Hi @ryansbenson per what @tombuildsstuff claims, this property has already existed in the API but just missing in swagger, will this condition needs a new api version?
More to ask, would proposing a new api version be done by customer?

If the live api version accepts and supports this property, it doesn't constitute a breaking api version change (as it already exists in the api version). This is essentially a documentation issue. If these properties came after the api version was released and we're trying to document it now, your customers have already gone through the side affects of the breaking change (this isn't a good experience but not something we can solve in swagger PRs).

Approving from ARMs side

tombuildsstuff · 2019-10-07T10:02:08Z

@ArcturusZhang sorry to ping you - would you mind tagging this "Service Team" so the Compute team could take a look? This is unfortunately blocking a couple of new resources we're trying to ship

vmss: support for passing a health probe to update

5b6736a

tombuildsstuff requested review from huangpf and hyonholee as code owners September 28, 2019 06:15

AutorestCI mentioned this pull request Sep 28, 2019

[AutoPR compute/resource-manager] vmss: support for passing a health probe to update Azure/azure-sdk-for-python#7479

Closed

AutorestCI mentioned this pull request Sep 28, 2019

[AutoPR compute/resource-manager] vmss: support for passing a health probe to update Azure/azure-sdk-for-go#5914

Merged

azuresdkci assigned ArcturusZhang Sep 28, 2019

azuresdkci requested a review from ArcturusZhang September 28, 2019 07:10

ArcturusZhang added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 29, 2019

ryansbenson reviewed Sep 30, 2019

View reviewed changes

ryansbenson added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 30, 2019

tombuildsstuff mentioned this pull request Oct 4, 2019

New Resource: azurerm_linux_virtual_machine_scale_set hashicorp/terraform-provider-azurerm#4518

Merged

ArcturusZhang approved these changes Oct 10, 2019

View reviewed changes

ArcturusZhang merged commit 4966cbc into Azure:master Oct 10, 2019

AutorestCI mentioned this pull request Oct 10, 2019

[AutoPR compute/resource-manager] vmss: support for passing a health probe to update Azure/azure-sdk-for-python#7758

Merged

hapandar mentioned this pull request Oct 17, 2019

SDK changes for swagger update to support AutomaticRepairsPolicy for Virtual Machine Scale Sets Azure/azure-sdk-for-net#8141

Merged

ArcturusZhang mentioned this pull request Jan 17, 2020

Update r/(linux|windows)_virtual_machine_scale_set - Add health_probe_id back to Update hashicorp/terraform-provider-azurerm#5430

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

vmss: support for passing a health probe to update #7355

vmss: support for passing a health probe to update #7355

tombuildsstuff commented Sep 28, 2019

openapi-sdkautomation bot commented Sep 28, 2019 •

edited

Loading

AutorestCI commented Sep 28, 2019 •

edited

Loading

AutorestCI commented Sep 28, 2019 •

edited

Loading

azuresdkci commented Sep 28, 2019

ryansbenson Sep 30, 2019

tombuildsstuff Oct 1, 2019

tombuildsstuff Oct 2, 2019

ArcturusZhang Oct 8, 2019

ArcturusZhang Oct 8, 2019

ryansbenson Oct 9, 2019

tombuildsstuff commented Oct 7, 2019

vmss: support for passing a health probe to update #7355

vmss: support for passing a health probe to update #7355

Conversation

tombuildsstuff commented Sep 28, 2019

openapi-sdkautomation bot commented Sep 28, 2019 • edited Loading

In Testing, Please Ignore

[Logs] (Generated from 5b6736a, Iteration 1)

AutorestCI commented Sep 28, 2019 • edited Loading

Automation for azure-sdk-for-python

AutorestCI commented Sep 28, 2019 • edited Loading

Automation for azure-sdk-for-go

azuresdkci commented Sep 28, 2019

ryansbenson Sep 30, 2019

Choose a reason for hiding this comment

tombuildsstuff Oct 1, 2019

Choose a reason for hiding this comment

tombuildsstuff Oct 2, 2019

Choose a reason for hiding this comment

ArcturusZhang Oct 8, 2019

Choose a reason for hiding this comment

ArcturusZhang Oct 8, 2019

Choose a reason for hiding this comment

ryansbenson Oct 9, 2019

Choose a reason for hiding this comment

tombuildsstuff commented Oct 7, 2019

openapi-sdkautomation bot commented Sep 28, 2019 •

edited

Loading

AutorestCI commented Sep 28, 2019 •

edited

Loading

AutorestCI commented Sep 28, 2019 •

edited

Loading