你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Dedicated Hosts - List By Host Group

参考

Service:: Compute

API Version:: 2024-03-01

Lists指定专用主机组中的所有专用主机。在响应中使用 nextLink 属性获取专用主机的下一页。

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

URI 参数

名称	在	必需	类型	说明
hostGroupName	path	True	string	专用主机组的名称。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	DedicatedHostListResult	确定
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

DedicatedHost_ListByHostGroup_MaximumSet_Gen

DedicatedHost_ListByHostGroup_MinimumSet_Gen

DedicatedHost_ListByHostGroup_MaximumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/hostGroups/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/hosts?api-version=2024-03-01


/**
 * Samples for DedicatedHosts ListByHostGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json
     */
    /**
     * Sample code: DedicatedHost_ListByHostGroup_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void dedicatedHostListByHostGroupMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDedicatedHosts().listByHostGroup("rgcompute",
            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 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

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_list_by_host_group_maximum_set_gen.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.list_by_host_group(
        resource_group_name="rgcompute",
        host_group_name="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json
func ExampleDedicatedHostsClient_NewListByHostGroupPager_dedicatedHostListByHostGroupMaximumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDedicatedHostsClient().NewListByHostGroupPager("rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DedicatedHostListResult = armcompute.DedicatedHostListResult{
		// 	Value: []*armcompute.DedicatedHost{
		// 		{
		// 			Name: to.Ptr("myDedicatedHost"),
		// 			Type: to.Ptr("aaaaaaaaaaaaaaaaaaa"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcompute.DedicatedHostProperties{
		// 				AutoReplaceOnFailure: to.Ptr(true),
		// 				HostID: to.Ptr("{GUID}"),
		// 				InstanceView: &armcompute.DedicatedHostInstanceView{
		// 					AssetID: to.Ptr("aaaaaaaaaaaaaaaa"),
		// 					AvailableCapacity: &armcompute.DedicatedHostAvailableCapacity{
		// 						AllocatableVMs: []*armcompute.DedicatedHostAllocatableVM{
		// 							{
		// 								Count: to.Ptr[float64](26),
		// 								VMSize: to.Ptr("aaaaaaaaaaaaaaaaaaaa"),
		// 						}},
		// 					},
		// 					Statuses: []*armcompute.InstanceViewStatus{
		// 						{
		// 							Code: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaa"),
		// 							DisplayStatus: to.Ptr("aaaaaa"),
		// 							Level: to.Ptr(armcompute.StatusLevelTypesInfo),
		// 							Message: to.Ptr("a"),
		// 							Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.522Z"); return t}()),
		// 					}},
		// 				},
		// 				LicenseType: to.Ptr(armcompute.DedicatedHostLicenseTypesWindowsServerHybrid),
		// 				PlatformFaultDomain: to.Ptr[int32](1),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				ProvisioningTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.526Z"); return t}()),
		// 				VirtualMachines: []*armcompute.SubResourceReadOnly{
		// 					{
		// 						ID: to.Ptr("aaaa"),
		// 				}},
		// 			},
		// 			SKU: &armcompute.SKU{
		// 				Name: to.Ptr("DSv3-Type1"),
		// 				Capacity: to.Ptr[int64](7),
		// 				Tier: to.Ptr("aaa"),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
 *
 * @summary Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json
 */
async function dedicatedHostListByHostGroupMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const hostGroupName = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.dedicatedHosts.listByHostGroup(resourceGroupName, hostGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "location": "westus",
      "tags": {},
      "properties": {
        "platformFaultDomain": 1,
        "autoReplaceOnFailure": true,
        "hostId": "{GUID}",
        "virtualMachines": [
          {
            "id": "aaaa"
          }
        ],
        "licenseType": "Windows_Server_Hybrid",
        "provisioningTime": "2021-11-30T12:58:26.526Z",
        "provisioningState": "aaaaaaaaaaaaaaaaaaaaaaaaa",
        "instanceView": {
          "assetId": "aaaaaaaaaaaaaaaa",
          "availableCapacity": {
            "allocatableVMs": [
              {
                "vmSize": "aaaaaaaaaaaaaaaaaaaa",
                "count": 26
              }
            ]
          },
          "statuses": [
            {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          ]
        }
      },
      "sku": {
        "name": "DSv3-Type1",
        "tier": "aaa",
        "capacity": 7
      },
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
      "name": "myDedicatedHost",
      "type": "aaaaaaaaaaaaaaaaaaa"
    }
  ],
  "nextLink": "aaaaaaa"
}

DedicatedHost_ListByHostGroup_MinimumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/hostGroups/aaaa/hosts?api-version=2024-03-01


/**
 * Samples for DedicatedHosts ListByHostGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json
     */
    /**
     * Sample code: DedicatedHost_ListByHostGroup_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void dedicatedHostListByHostGroupMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDedicatedHosts().listByHostGroup("rgcompute", "aaaa",
            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

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_list_by_host_group_minimum_set_gen.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.list_by_host_group(
        resource_group_name="rgcompute",
        host_group_name="aaaa",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.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

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json
func ExampleDedicatedHostsClient_NewListByHostGroupPager_dedicatedHostListByHostGroupMinimumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDedicatedHostsClient().NewListByHostGroupPager("rgcompute", "aaaa", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DedicatedHostListResult = armcompute.DedicatedHostListResult{
		// 	Value: []*armcompute.DedicatedHost{
		// 		{
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost"),
		// 			Location: to.Ptr("westus"),
		// 			SKU: &armcompute.SKU{
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
 *
 * @summary Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json
 */
async function dedicatedHostListByHostGroupMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const hostGroupName = "aaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.dedicatedHosts.listByHostGroup(resourceGroupName, hostGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "location": "westus",
      "sku": {},
      "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost"
    }
  ]
}

定义

名称	说明
ApiError	Api 错误。
ApiErrorBase	Api 错误基。
CloudError	来自计算服务的错误响应。
DedicatedHost	指定有关专用主机的信息。
DedicatedHostAllocatableVM	表示特定 VM 大小的专用主机未使用容量。
DedicatedHostAvailableCapacity	专用主机未使用容量。
DedicatedHostInstanceView	专用主机的实例视图。
DedicatedHostLicenseTypes	指定将应用于部署在专用主机上的 VM 的软件许可证类型。可能的值为： None、Windows_Server_Hybrid、Windows_Server_Perpetual。默认值为： None。
DedicatedHostListResult	列表专用主机操作响应。
InnerError	内部错误详细信息。
InstanceViewStatus	实例视图状态。
Sku	介绍虚拟机规模集 SKU。注意：如果规模集当前使用的硬件不支持新的 VM SKU，则需要在修改 SKU 名称之前解除分配规模集中的 VM。
StatusLevelTypes	级别代码。
SubResourceReadOnly

ApiError

Api 错误。

名称	类型	说明
code	string	错误代码。
details	ApiErrorBase[]	Api 错误详细信息
innererror	InnerError	Api 内部错误
message	string	错误消息。
target	string	特定错误的目标。

ApiErrorBase

Api 错误基。

名称	类型	说明
code	string	错误代码。
message	string	错误消息。
target	string	特定错误的目标。

CloudError

来自计算服务的错误响应。

名称	类型	说明
error	ApiError	Api 错误。

DedicatedHost

指定有关专用主机的信息。

名称	类型	说明
id	string	资源 ID
location	string	资源位置
name	string	资源名称
properties.autoReplaceOnFailure	boolean	指定在发生故障时是否应自动替换专用主机。如果未提供该值，则该值默认为“true”。
properties.hostId	string	由平台生成并分配给专用主机的唯一 ID。在主机的整个生存期内不会更改。
properties.instanceView	DedicatedHostInstanceView	专用主机实例视图。
properties.licenseType	DedicatedHostLicenseTypes	指定将应用于部署在专用主机上的 VM 的软件许可证类型。可能的值为： None、Windows_Server_Hybrid、Windows_Server_Perpetual。默认值为： None。
properties.platformFaultDomain	integer	专用主机组中专用主机的容错域。
properties.provisioningState	string	预配状态，仅显示在响应中。
properties.provisioningTime	string	首次预配主机的日期。
properties.timeCreated	string	指定创建专用主机资源的时间。最低 API 版本：2021-11-01。
properties.virtualMachines	SubResourceReadOnly[]	对专用主机中所有虚拟机的引用列表。
sku	Sku	硬件代系和 VM 系列的专用主机的 SKU。只需设置名称。列出 Microsoft.Compute SKU 以获取可能值的列表。
tags	object	资源标记
type	string	资源类型

DedicatedHostAllocatableVM

表示特定 VM 大小的专用主机未使用容量。

名称	类型	说明
count	number	可以容纳专用主机剩余容量的 vmSize 大小的最大 VM 数。
vmSize	string	表示未使用的容量的 VM 大小。

DedicatedHostAvailableCapacity

专用主机未使用容量。

名称	类型	说明
allocatableVMs	DedicatedHostAllocatableVM[]	专用主机的未使用容量表示为允许部署到专用主机的每个 VM 大小。

DedicatedHostInstanceView

专用主机的实例视图。

名称	类型	说明
assetId	string	指定专用主机所在的专用物理计算机的唯一 ID。
availableCapacity	DedicatedHostAvailableCapacity	专用主机的未使用容量。
statuses	InstanceViewStatus[]	资源状态信息。

DedicatedHostLicenseTypes

指定将应用于部署在专用主机上的 VM 的软件许可证类型。可能的值为： None、Windows_Server_Hybrid、Windows_Server_Perpetual。 默认值为： None。

名称	类型	说明
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

DedicatedHostListResult

列表专用主机操作响应。

名称	类型	说明
nextLink	string	用于提取专用主机的下一页的 URI。使用此 URI 调用 ListNext () 来提取专用主机的下一页。
value	DedicatedHost[]	专用主机列表

InnerError

内部错误详细信息。

名称	类型	说明
errordetail	string	内部错误消息或异常转储。
exceptiontype	string	异常类型。

InstanceViewStatus

实例视图状态。

名称	类型	说明
code	string	状态代码。
displayStatus	string	状态的简短可本地化标签。
level	StatusLevelTypes	级别代码。
message	string	详细状态消息，包括警报和错误消息。
time	string	状态的时间。

Sku

介绍虚拟机规模集 SKU。注意：如果规模集当前使用的硬件不支持新的 VM SKU，则需要在修改 SKU 名称之前解除分配规模集中的 VM。

名称	类型	说明
capacity	integer	指定规模集中的虚拟机数。
name	string	SKU 名称。
tier	string	指定规模集中虚拟机的层。可能的值：标准基本

StatusLevelTypes

级别代码。

名称	类型	说明
Error	string
Info	string
Warning	string

SubResourceReadOnly

名称	类型	说明
id	string	资源 ID

Dedicated Hosts - List By Host Group

URI 参数

响应

安全性

azure_auth

Scopes

示例

DedicatedHost_ListByHostGroup_MaximumSet_Gen

Sample Request

Sample Response

DedicatedHost_ListByHostGroup_MinimumSet_Gen

Sample Request

Sample Response

定义

ApiError

ApiErrorBase

CloudError

DedicatedHost

DedicatedHostAllocatableVM

DedicatedHostAvailableCapacity

DedicatedHostInstanceView

DedicatedHostLicenseTypes

DedicatedHostListResult

InnerError

InstanceViewStatus

Sku

StatusLevelTypes

SubResourceReadOnly

其他资源