Dedicated Hosts - List By Host Group

參考

Service:: Compute

API Version:: 2024-03-01

清單指定專用主機群組中的所有專用主機。在回應中使用 nextLink 屬性來取得專用主機的下一頁。

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

URI 參數

名稱	位於	必要	類型	Description
hostGroupName	path	True	string	專用主機群組的名稱。
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	DedicatedHostListResult	確定
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

DedicatedHost_ListByHostGroup_MaximumSet_Gen

DedicatedHost_ListByHostGroup_MinimumSet_Gen

DedicatedHost_ListByHostGroup_MaximumSet_Gen

Sample Request

HTTP

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

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

HTTP

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

Sample Response

Status code:: 200

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

定義

名稱	Description
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，您必須先解除分配擴展集中的 VM，才能修改 SKU 名稱。
StatusLevelTypes	層級程序代碼。
SubResourceReadOnly

ApiError

API 錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	ApiErrorBase[]	API 錯誤詳細數據
innererror	InnerError	Api 內部錯誤
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApiErrorBase

API 錯誤基底。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

CloudError

來自計算服務的錯誤回應。

名稱	類型	Description
error	ApiError	API 錯誤。

DedicatedHost

指定專用主機的相關信息。

名稱	類型	Description
id	string	資源標識碼
location	string	資源位置
name	string	資源名稱
properties.autoReplaceOnFailure	boolean	指定在發生失敗時，是否應該自動取代專用主機。未提供時，此值預設為『true』。
properties.hostId	string	由平台產生並指派給專用主機的唯一標識符。不會在主機的存留期內變更。
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-version：2021-11-01。
properties.virtualMachines	SubResourceReadOnly[]	專用主機中所有虛擬機的參考清單。
sku	Sku	硬體世代和 VM 系列專用主機的 SKU。只需要設定名稱。列出 Microsoft.Compute SKU 以取得可能的值清單。
tags	object	資源標籤
type	string	資源類型

DedicatedHostAllocatableVM

代表專用主機未使用容量的特定 VM 大小。

名稱	類型	Description
count	number	大小 vmSize 的 VM 數目上限，可符合專用主機的剩餘容量。
vmSize	string	以未使用量容量表示的 VM 大小。

DedicatedHostAvailableCapacity

專用主機未使用容量。

名稱	類型	Description
allocatableVMs	DedicatedHostAllocatableVM[]	以允許部署到專用主機的每個 VM 大小而言，專用主機的未使用量容量。

DedicatedHostInstanceView

專用主機的實例檢視。

名稱	類型	Description
assetId	string	指定專用主機所在專用實體機器的唯一標識碼。
availableCapacity	DedicatedHostAvailableCapacity	專用主機的未使用容量。
statuses	InstanceViewStatus[]	資源狀態資訊。

DedicatedHostLicenseTypes

指定將套用至部署在專用主機上之 VM 的軟體授權類型。可能的值為： None、Windows_Server_Hybrid、Windows_Server_Perpetual。 默認值為： None。

名稱	類型	Description
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

DedicatedHostListResult

清單專用主機作業回應。

名稱	類型	Description
nextLink	string	要擷取專用主機下一頁的 URI。使用此 URI 呼叫 ListNext () ，以擷取專用主機的下一頁。
value	DedicatedHost[]	專用主機清單

InnerError

內部錯誤詳細數據。

名稱	類型	Description
errordetail	string	內部錯誤訊息或例外狀況傾印。
exceptiontype	string	例外狀況型別。

InstanceViewStatus

實例檢視狀態。

名稱	類型	Description
code	string	狀態碼。
displayStatus	string	狀態的簡短可當地語系化標籤。
level	StatusLevelTypes	層級程序代碼。
message	string	詳細的狀態消息，包括警示和錯誤訊息。
time	string	狀態的時間。

Sku

描述虛擬機擴展集 SKU。注意：如果擴展集目前所在的硬體上不支援新的 VM SKU，您必須先解除分配擴展集中的 VM，才能修改 SKU 名稱。

名稱	類型	Description
capacity	integer	指定擴展集中的虛擬機數目。
name	string	SKU 名稱。
tier	string	指定擴展集中的虛擬機層。可能的值如下：標準基本

StatusLevelTypes

層級程序代碼。

名稱	類型	Description
Error	string
Info	string
Warning	string

SubResourceReadOnly

名稱	類型	Description
id	string	資源標識碼

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

其他資源