Dedicated Hosts - Get

リファレンス

Service:: Compute

API Version:: 2024-03-01

専用ホストに関する情報を取得します。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
hostGroupName	path	True	string	専用ホストグループの名前。
hostName	path	True	string	専用ホストの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。
$expand	query		InstanceViewTypes	操作に適用する展開式。 'InstanceView' は、専用ホストのインスタンスビューの一覧を取得します。 'UserData' は専用ホストではサポートされていません。

応答

名前	型	説明
200 OK	DedicatedHost	OK
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	ユーザーアカウントの借用

例

Get a dedicated host.

Sample Request

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


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

/**
 * Samples for DedicatedHosts Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * dedicatedHostExamples/DedicatedHost_Get.json
     */
    /**
     * Sample code: Get a dedicated host.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getADedicatedHost(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().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

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="{subscriptionId}",
    )

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


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

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/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_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("<subscription-id>", 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.DedicatedHost = armcompute.DedicatedHost{
	// 	Name: to.Ptr("myHost"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"department": to.Ptr("HR"),
	// 	},
	// 	Properties: &armcompute.DedicatedHostProperties{
	// 		AutoReplaceOnFailure: to.Ptr(true),
	// 		HostID: to.Ptr("{GUID}"),
	// 		InstanceView: &armcompute.DedicatedHostInstanceView{
	// 			AssetID: to.Ptr("eb3f58b8-b4e8-4882-b69f-301a01812407"),
	// 			AvailableCapacity: &armcompute.DedicatedHostAvailableCapacity{
	// 				AllocatableVMs: []*armcompute.DedicatedHostAllocatableVM{
	// 					{
	// 						Count: to.Ptr[float64](10),
	// 						VMSize: to.Ptr("Standard_A1"),
	// 				}},
	// 			},
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				},
	// 				{
	// 					Code: to.Ptr("HealthState/available"),
	// 					DisplayStatus: to.Ptr("Host available"),
	// 					Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			}},
	// 		},
	// 		PlatformFaultDomain: to.Ptr[int32](1),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ProvisioningTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-27T01:02:38.313Z"); return t}()),
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-27T01:02:38.313Z"); return t}()),
	// 		VirtualMachines: []*armcompute.SubResourceReadOnly{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1"),
	// 		}},
	// 	},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("DSv3-Type1"),
	// 	},
	// }
}

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 Retrieves information about a dedicated host.
 *
 * @summary Retrieves information about a dedicated host.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_Get.json
 */
async function getADedicatedHost() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscriptionId}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const hostGroupName = "myDedicatedHostGroup";
  const hostName = "myHost";
  const expand = "instanceView";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.dedicatedHosts.get(
    resourceGroupName,
    hostGroupName,
    hostName,
    options,
  );
  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"
}

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピューティングサービスからのエラー応答。
DedicatedHost	専用ホストに関する情報を指定します。
DedicatedHostAllocatableVM	特定の VM サイズの観点から、専用ホストの未使用容量を表します。
DedicatedHostAvailableCapacity	専用ホストの未使用容量。
DedicatedHostInstanceView	専用ホストのインスタンスビュー。
DedicatedHostLicenseTypes	専用ホストにデプロイされた VM に適用されるソフトウェアライセンスの種類を指定します。使用可能な値は、なし、Windows_Server_Hybrid、Windows_Server_Perpetualです。既定値は None です。
InnerError	内部エラーの詳細。
InstanceViewStatus	インスタンスビューの状態。
InstanceViewTypes	操作に適用する展開式。 'InstanceView' は、専用ホストのインスタンスビューの一覧を取得します。 'UserData' は専用ホストではサポートされていません。
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 に適用されるソフトウェアライセンスの種類を指定します。使用可能な値は、なし、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 サイズの観点から、専用ホストの未使用容量を表します。

名前	型	説明
count	number	専用ホストの残りの容量に収めることができる vmSize サイズの VM の最大数。
vmSize	string	未使用の容量を表す VM サイズ。

DedicatedHostAvailableCapacity

専用ホストの未使用容量。

名前	型	説明
allocatableVMs	DedicatedHostAllocatableVM[]	専用ホストへのデプロイが許可されている各 VM サイズの観点から表される専用ホストの未使用容量。

DedicatedHostInstanceView

専用ホストのインスタンスビュー。

名前	型	説明
assetId	string	専用ホストが存在する専用物理マシンの一意の ID を指定します。
availableCapacity	DedicatedHostAvailableCapacity	専用ホストの未使用容量。
statuses	InstanceViewStatus[]	リソースの状態情報。

DedicatedHostLicenseTypes

専用ホストにデプロイされた VM に適用されるソフトウェアライセンスの種類を指定します。使用可能な値は 、なし、Windows_Server_Hybrid、Windows_Server_Perpetualです。 既定値は None です。

名前	型	説明
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

InstanceViewStatus

インスタンスビューの状態。

名前	型	説明
code	string	ステータスコード。
displayStatus	string	状態の短いローカライズ可能なラベル。
level	StatusLevelTypes	レベルコード。
message	string	アラートとエラーメッセージを含む詳細なステータスメッセージ。
time	string	状態の時刻。

InstanceViewTypes

操作に適用する展開式。 'InstanceView' は、専用ホストのインスタンスビューの一覧を取得します。 'UserData' は専用ホストではサポートされていません。

名前	型	説明
instanceView	string
userData	string

Sku

仮想マシンスケールセット SKU について説明します。注: スケールセットが現在オンになっているハードウェアで新しい VM SKU がサポートされていない場合は、SKU 名を変更する前に、スケールセット内の VM の割り当てを解除する必要があります。

名前	型	説明
capacity	integer	スケールセット内の仮想マシンの数を指定します。
name	string	SKU 名。
tier	string	スケールセット内の仮想マシンの層を指定します。有効値は次のとおりです。 Standard Basic

StatusLevelTypes

レベルコード。

名前	型	説明
Error	string
Info	string
Warning	string

SubResourceReadOnly

名前	型	説明
id	string	リソース ID

Share via

Dedicated Hosts - Get

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

Get a dedicated host.

Sample Request

Sample Response

定義

ApiError

ApiErrorBase

CloudError

DedicatedHost

DedicatedHostAllocatableVM

DedicatedHostAvailableCapacity

DedicatedHostInstanceView

DedicatedHostLicenseTypes

InnerError

InstanceViewStatus

InstanceViewTypes

Sku

StatusLevelTypes

SubResourceReadOnly

その他のリソース