PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/?api-version=2023-09-01
Update an dedicated host group.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
hostGroupName |
String | Yes |
The name of the dedicated host group. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
properties |
Object | No |
Dedicated Host Group Properties. |
properties.additionalCapabilities |
Object | No |
Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. |
properties.additionalCapabilities.ultraSSDEnabled |
Boolean | No |
The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. Note: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. |
properties.instanceView |
Object | No | |
properties.instanceView.hosts[] |
Array | No |
List of instance view of the dedicated hosts under the dedicated host group. |
properties.instanceView.hosts[].name |
String | No |
The name of the dedicated host. |
properties.instanceView.hosts[].availableCapacity |
Object | No |
Dedicated host unutilized capacity. |
properties.instanceView.hosts[].availableCapacity.allocatableVMs[] |
Array | No |
The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. |
properties.instanceView.hosts[].availableCapacity.allocatableVMs[].count |
Number | No |
Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. |
properties.instanceView.hosts[].availableCapacity.allocatableVMs[].vmSize |
String | No |
VM size in terms of which the unutilized capacity is represented. |
properties.instanceView.hosts[].statuses[] |
Array | No |
The resource status information. |
properties.instanceView.hosts[].statuses[].time |
String | No |
The time of the status. |
properties.instanceView.hosts[].statuses[].displayStatus |
String | No |
The short localizable label for the status. |
properties.instanceView.hosts[].statuses[].message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.instanceView.hosts[].statuses[].level |
String | No |
The level code. Possible values:
|
properties.instanceView.hosts[].statuses[].code |
String | No |
The status code. |
properties.instanceView.hosts[].assetId |
String | No |
Specifies the unique id of the dedicated physical machine on which the dedicated host resides. |
properties.platformFaultDomainCount |
Integer | Yes |
Number of fault domains that the host group can span. |
properties.supportAutomaticPlacement |
Boolean | No |
Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. |
properties.hosts[] |
Array | No |
A list of references to all dedicated hosts in the dedicated host group. |
properties.hosts[].id |
String | No |
Resource Id |
zones[] |
Array | No |
Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. |
tags |
Object | No |
Resource tags |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.