PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/?api-version=2023-09-01
Update a dedicated host .
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. |
hostName |
String | Yes |
The name of the dedicated host . |
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 |
|---|---|---|---|
sku |
Object | No |
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name. |
sku.tier |
String | No |
Specifies the tier of virtual machines in a scale set. |
sku.name |
String | No |
The sku name. |
sku.capacity |
Integer | No |
Specifies the number of virtual machines in the scale set. |
properties |
Object | No |
Properties of the dedicated host. |
properties.virtualMachines[] |
Array | No |
A list of references to all virtual machines in the Dedicated Host. |
properties.virtualMachines[].id |
String | No |
Resource Id |
properties.autoReplaceOnFailure |
Boolean | No |
Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. |
properties.timeCreated |
String | No |
Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. |
properties.hostId |
String | No |
A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. |
properties.platformFaultDomain |
Integer | No |
Fault domain of the dedicated host within a dedicated host group. |
properties.provisioningState |
String | No |
The provisioning state, which only appears in the response. |
properties.instanceView |
Object | No |
The instance view of a dedicated host. |
properties.instanceView.availableCapacity |
Object | No |
Dedicated host unutilized capacity. |
properties.instanceView.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.availableCapacity.allocatableVMs[].count |
Number | No |
Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. |
properties.instanceView.availableCapacity.allocatableVMs[].vmSize |
String | No |
VM size in terms of which the unutilized capacity is represented. |
properties.instanceView.statuses[] |
Array | No |
The resource status information. |
properties.instanceView.statuses[].time |
String | No |
The time of the status. |
properties.instanceView.statuses[].displayStatus |
String | No |
The short localizable label for the status. |
properties.instanceView.statuses[].message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.instanceView.statuses[].level |
String | No |
The level code. Possible values:
|
properties.instanceView.statuses[].code |
String | No |
The status code. |
properties.instanceView.assetId |
String | No |
Specifies the unique id of the dedicated physical machine on which the dedicated host resides. |
properties.licenseType |
String | No |
Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None. Possible values:
|
properties.provisioningTime |
String | No |
The date when the host was first provisioned. |
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.