Dedicated Hosts - Get

Service:

Compute

API Version:

2026-04-01

Retrieves information about a dedicated host.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}?api-version=2026-04-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}?api-version=2026-04-01&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
hostGroupName	path	True	string	The name of the dedicated host group.
hostName	path	True	string	The name of the dedicated host.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$expand	query		InstanceViewTypes	The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host.

Responses

Name	Type	Description
200 OK	DedicatedHost	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get a dedicated host.

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myDedicatedHostGroup/hosts/myHost?api-version=2026-04-01&$expand=instanceView

Java

import com.azure.resourcemanager.compute.models.InstanceViewTypes;

/**
 * Samples for DedicatedHosts Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-04-01/dedicatedHostExamples/DedicatedHost_Get.json
     */
    /**
     * Sample code: Get a dedicated host.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void getADedicatedHost(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getDedicatedHosts().getWithResponse("myResourceGroup", "myDedicatedHostGroup", "myHost",
            InstanceViewTypes.INSTANCE_VIEW, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python dedicated_host_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.dedicated_hosts.get(
        resource_group_name="myResourceGroup",
        host_group_name="myDedicatedHostGroup",
        host_name="myHost",
    )
    print(response)


# x-ms-original-file: 2026-04-01/dedicatedHostExamples/DedicatedHost_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v9"
)

// Generated from example definition: 2026-04-01/dedicatedHostExamples/DedicatedHost_Get.json
func ExampleDedicatedHostsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscriptionId}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDedicatedHostsClient().Get(ctx, "myResourceGroup", "myDedicatedHostGroup", "myHost", &armcompute.DedicatedHostsClientGetOptions{
		Expand: to.Ptr(armcompute.InstanceViewTypesInstanceView)})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.DedicatedHostsClientGetResponse{
	// 	DedicatedHost: armcompute.DedicatedHost{
	// 		ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost"),
	// 		Properties: &armcompute.DedicatedHostProperties{
	// 			PlatformFaultDomain: to.Ptr[int32](1),
	// 			AutoReplaceOnFailure: to.Ptr(true),
	// 			HostID: to.Ptr("{GUID}"),
	// 			ProvisioningTime: to.Ptr(time.Date(2019, time.June, 27, 1, 2, 38, 313846900, time.UTC)),
	// 			VirtualMachines: []*armcompute.SubResourceReadOnly{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1"),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			InstanceView: &armcompute.DedicatedHostInstanceView{
	// 				AssetID: to.Ptr("eb3f58b8-b4e8-4882-b69f-301a01812407"),
	// 				AvailableCapacity: &armcompute.DedicatedHostAvailableCapacity{
	// 					AllocatableVMs: []*armcompute.DedicatedHostAllocatableVM{
	// 						{
	// 							VMSize: to.Ptr("Standard_A1"),
	// 							Count: to.Ptr[float64](10),
	// 						},
	// 					},
	// 				},
	// 				Statuses: []*armcompute.InstanceViewStatus{
	// 					{
	// 						Code: to.Ptr("ProvisioningState/succeeded"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					},
	// 					{
	// 						Code: to.Ptr("HealthState/available"),
	// 						Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 						DisplayStatus: to.Ptr("Host available"),
	// 					},
	// 				},
	// 			},
	// 			TimeCreated: to.Ptr(time.Date(2019, time.June, 27, 1, 2, 38, 313846900, time.UTC)),
	// 		},
	// 		Location: to.Ptr("westus"),
	// 		Tags: map[string]*string{
	// 			"department": to.Ptr("HR"),
	// 		},
	// 		SKU: &armcompute.SKU{
	// 			Name: to.Ptr("DSv3-Type1"),
	// 		},
	// 		Name: to.Ptr("myHost"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to retrieves information about a dedicated host.
 *
 * @summary retrieves information about a dedicated host.
 * x-ms-original-file: 2026-04-01/dedicatedHostExamples/DedicatedHost_Get.json
 */
async function getADedicatedHost() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscriptionId}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.dedicatedHosts.get(
    "myResourceGroup",
    "myDedicatedHostGroup",
    "myHost",
    { expand: "instanceView" },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost",
  "properties": {
    "platformFaultDomain": 1,
    "autoReplaceOnFailure": true,
    "hostId": "{GUID}",
    "provisioningTime": "2019-06-27T01:02:38.3138469+00:00",
    "virtualMachines": [
      {
        "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1"
      }
    ],
    "provisioningState": "Succeeded",
    "instanceView": {
      "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407",
      "availableCapacity": {
        "allocatableVMs": [
          {
            "vmSize": "Standard_A1",
            "count": 10
          }
        ]
      },
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded"
        },
        {
          "code": "HealthState/available",
          "level": "Info",
          "displayStatus": "Host available"
        }
      ]
    },
    "timeCreated": "2019-06-27T01:02:38.3138469+00:00"
  },
  "location": "westus",
  "tags": {
    "department": "HR"
  },
  "sku": {
    "name": "DSv3-Type1"
  },
  "name": "myHost"
}

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
CloudError	An error response from the Compute service.
createdByType	The type of identity that created the resource.
DedicatedHost	Specifies information about the Dedicated host.
DedicatedHostAllocatableVM	Represents the dedicated host unutilized capacity in terms of a specific VM size.
DedicatedHostAvailableCapacity	Dedicated host unutilized capacity.
DedicatedHostInstanceView	The instance view of a dedicated host.
DedicatedHostLicenseTypes	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.
InnerError	Inner error details.
InstanceViewStatus	Instance view status.
InstanceViewTypes
Sku	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.
StatusLevelTypes	The level code.
SubResourceReadOnly
systemData	Metadata pertaining to creation and last modification of the resource.

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

Api error base.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

CloudError

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DedicatedHost

Object

Specifies information about the Dedicated host.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.autoReplaceOnFailure	boolean	Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
properties.hostId	string	A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
properties.instanceView	DedicatedHostInstanceView	The dedicated host instance view.
properties.licenseType	DedicatedHostLicenseTypes	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.
properties.platformFaultDomain	integer (int32)	Fault domain of the dedicated host within a dedicated host group.
properties.provisioningState	string	The provisioning state, which only appears in the response.
properties.provisioningTime	string (date-time)	The date when the host was first provisioned.
properties.timeCreated	string (date-time)	Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
properties.virtualMachines	SubResourceReadOnly[]	A list of references to all virtual machines in the Dedicated Host.
sku	Sku	SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DedicatedHostAllocatableVM

Object

Represents the dedicated host unutilized capacity in terms of a specific VM size.

Name	Type	Description
count	number (double)	Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.
vmSize	string	VM size in terms of which the unutilized capacity is represented.

DedicatedHostAvailableCapacity

Object

Dedicated host unutilized capacity.

Name	Type	Description
allocatableVMs	DedicatedHostAllocatableVM[]	The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

DedicatedHostInstanceView

Object

The instance view of a dedicated host.

Name	Type	Description
assetId	string	Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
availableCapacity	DedicatedHostAvailableCapacity	Unutilized capacity of the dedicated host.
statuses	InstanceViewStatus[]	The resource status information.

DedicatedHostLicenseTypes

Enumeration

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.

Value	Description
None
Windows_Server_Hybrid
Windows_Server_Perpetual

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

InstanceViewStatus

Object

Instance view status.

Name	Type	Description
code	string	The status code.
displayStatus	string	The short localizable label for the status.
level	StatusLevelTypes	The level code.
message	string	The detailed status message, including for alerts and error messages.
time	string (date-time)	The time of the status.

InstanceViewTypes

Enumeration

Value	Description
instanceView
userData
resiliencyView

Sku

Object

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.

Name	Type	Description
capacity	integer (int64)	Specifies the number of virtual machines in the scale set.
name	string	The sku name.
tier	string	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

StatusLevelTypes

Enumeration

The level code.

Value	Description
Info
Warning
Error

SubResourceReadOnly

Object

Name	Type	Description
id	string	Resource Id

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.