Virtual Machines - List By Resource Group

サービス:

Operator Nexus - Network Cloud

API バージョン:

2023-07-01

リソース グループ内の仮想マシンを一覧表示します。
指定されたリソース グループ内の仮想マシンの一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines?api-version=2023-07-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	VirtualMachineList	わかりました
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

List virtual machines for resource group

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines?api-version=2023-07-01

Java

/** Samples for VirtualMachines ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_ListByResourceGroup.json
     */
    /**
     * Sample code: List virtual machines for resource group.
     *
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void listVirtualMachinesForResourceGroup(
        com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.virtualMachines().listByResourceGroup("resourceGroupName", 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.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python virtual_machines_list_by_resource_group.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.virtual_machines.list_by_resource_group(
        resource_group_name="resourceGroupName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_ListByResourceGroup.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 armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_ListByResourceGroup.json
func ExampleVirtualMachinesClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVirtualMachinesClient().NewListByResourceGroupPager("resourceGroupName", 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.VirtualMachineList = armnetworkcloud.VirtualMachineList{
		// 	Value: []*armnetworkcloud.VirtualMachine{
		// 		{
		// 			Name: to.Ptr("virtualMachineName"),
		// 			Type: to.Ptr("Microsoft.NetworkCloud/virtualMachines"),
		// 			ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName"),
		// 			SystemData: &armnetworkcloud.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
		// 				CreatedBy: to.Ptr("identityA"),
		// 				CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("identityB"),
		// 				LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("location"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("myvalue1"),
		// 				"key2": to.Ptr("myvalue2"),
		// 			},
		// 			ExtendedLocation: &armnetworkcloud.ExtendedLocation{
		// 				Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
		// 				Type: to.Ptr("CustomLocation"),
		// 			},
		// 			Properties: &armnetworkcloud.VirtualMachineProperties{
		// 				AdminUsername: to.Ptr("username"),
		// 				AvailabilityZone: to.Ptr("1"),
		// 				BareMetalMachineID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName"),
		// 				BootMethod: to.Ptr(armnetworkcloud.VirtualMachineBootMethodUEFI),
		// 				CloudServicesNetworkAttachment: &armnetworkcloud.NetworkAttachment{
		// 					AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName"),
		// 					IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 				},
		// 				ClusterID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName"),
		// 				CPUCores: to.Ptr[int64](2),
		// 				DetailedStatus: to.Ptr(armnetworkcloud.VirtualMachineDetailedStatusAvailable),
		// 				DetailedStatusMessage: to.Ptr("VM is up and healthy"),
		// 				MemorySizeGB: to.Ptr[int64](8),
		// 				NetworkAttachments: []*armnetworkcloud.NetworkAttachment{
		// 					{
		// 						AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
		// 						DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayTrue),
		// 						IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
		// 						IPv4Address: to.Ptr("198.51.100.1"),
		// 						IPv6Address: to.Ptr("2001:0db8:0000:0000:0000:0000:0000:0000"),
		// 						MacAddress: to.Ptr("bf:1c:29:31:31:1f"),
		// 						NetworkAttachmentName: to.Ptr("netAttachName01"),
		// 				}},
		// 				NetworkData: to.Ptr("bmV0d29ya0RhdGVTYW1wbGU="),
		// 				PlacementHints: []*armnetworkcloud.VirtualMachinePlacementHint{
		// 					{
		// 						HintType: to.Ptr(armnetworkcloud.VirtualMachinePlacementHintTypeAffinity),
		// 						ResourceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName"),
		// 						SchedulingExecution: to.Ptr(armnetworkcloud.VirtualMachineSchedulingExecutionHard),
		// 						Scope: to.Ptr(armnetworkcloud.VirtualMachinePlacementHintPodAffinityScope("")),
		// 				}},
		// 				PowerState: to.Ptr(armnetworkcloud.VirtualMachinePowerStateOn),
		// 				ProvisioningState: to.Ptr(armnetworkcloud.VirtualMachineProvisioningStateSucceeded),
		// 				SSHPublicKeys: []*armnetworkcloud.SSHPublicKey{
		// 					{
		// 						KeyData: to.Ptr("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
		// 				}},
		// 				StorageProfile: &armnetworkcloud.StorageProfile{
		// 					OSDisk: &armnetworkcloud.OsDisk{
		// 						CreateOption: to.Ptr(armnetworkcloud.OsDiskCreateOptionEphemeral),
		// 						DeleteOption: to.Ptr(armnetworkcloud.OsDiskDeleteOptionDelete),
		// 						DiskSizeGB: to.Ptr[int64](120),
		// 					},
		// 					VolumeAttachments: []*string{
		// 						to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName")},
		// 					},
		// 					UserData: to.Ptr("dXNlckRhdGVTYW1wbGU="),
		// 					VMDeviceModel: to.Ptr(armnetworkcloud.VirtualMachineDeviceModelTypeT2),
		// 					VMImage: to.Ptr("myacr.azurecr.io/foobar:latest"),
		// 					VMImageRepositoryCredentials: &armnetworkcloud.ImageRepositoryCredentials{
		// 						RegistryURL: to.Ptr("myacr.azurecr.io"),
		// 						Username: to.Ptr("myuser"),
		// 					},
		// 					Volumes: []*string{
		// 						to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName")},
		// 					},
		// 			}},
		// 		}
	}
}

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 { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a list of virtual machines in the provided resource group.
 *
 * @summary Get a list of virtual machines in the provided resource group.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_ListByResourceGroup.json
 */
async function listVirtualMachinesForResourceGroup() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const resourceGroupName = process.env["NETWORKCLOUD_RESOURCE_GROUP"] || "resourceGroupName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualMachines.listByResourceGroup(resourceGroupName)) {
    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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.NetworkCloud;
using Azure.ResourceManager.NetworkCloud.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_ListByResourceGroup.json
// this example is just showing the usage of "VirtualMachines_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
string resourceGroupName = "resourceGroupName";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetworkCloudVirtualMachineResource
NetworkCloudVirtualMachineCollection collection = resourceGroupResource.GetNetworkCloudVirtualMachines();

// invoke the operation and iterate over the result
await foreach (NetworkCloudVirtualMachineResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetworkCloudVirtualMachineData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName",
      "name": "virtualMachineName",
      "systemData": {
        "createdAt": "2021-01-22T13:27:03.008Z",
        "createdBy": "identityA",
        "createdByType": "Application",
        "lastModifiedAt": "2021-01-22T13:29:03.001Z",
        "lastModifiedBy": "identityB",
        "lastModifiedByType": "User"
      },
      "type": "Microsoft.NetworkCloud/virtualMachines",
      "location": "location",
      "tags": {
        "key1": "myvalue1",
        "key2": "myvalue2"
      },
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
      },
      "properties": {
        "vmImage": "myacr.azurecr.io/foobar:latest",
        "vmImageRepositoryCredentials": {
          "username": "myuser",
          "registryUrl": "myacr.azurecr.io"
        },
        "vmDeviceModel": "T2",
        "cpuCores": 2,
        "memorySizeGB": 8,
        "storageProfile": {
          "osDisk": {
            "createOption": "Ephemeral",
            "deleteOption": "Delete",
            "diskSizeGB": 120
          },
          "volumeAttachments": [
            "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
          ]
        },
        "cloudServicesNetworkAttachment": {
          "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
          "ipAllocationMethod": "Dynamic"
        },
        "networkAttachments": [
          {
            "networkAttachmentName": "netAttachName01",
            "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
            "ipAllocationMethod": "Dynamic",
            "ipv4Address": "198.51.100.1",
            "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
            "macAddress": "bf:1c:29:31:31:1f",
            "defaultGateway": "True"
          }
        ],
        "placementHints": [
          {
            "hintType": "Affinity",
            "schedulingExecution": "Hard",
            "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
            "scope": ""
          }
        ],
        "userData": "dXNlckRhdGVTYW1wbGU=",
        "networkData": "bmV0d29ya0RhdGVTYW1wbGU=",
        "bootMethod": "UEFI",
        "adminUsername": "username",
        "sshPublicKeys": [
          {
            "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
          }
        ],
        "provisioningState": "Succeeded",
        "availabilityZone": "1",
        "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
        "powerState": "On",
        "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
        "detailedStatus": "Available",
        "detailedStatusMessage": "VM is up and healthy",
        "volumes": [
          "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
        ]
      }
    }
  ],
  "nextLink": "https://fully.qualified.hyperlink"
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
DefaultGateway	これが既定のゲートウェイであるかどうかを示すインジケーター。 1 台のマシンに対して接続されているネットワーク (CloudServicesNetwork 添付ファイルを含む) の 1 つだけを True として指定できます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ExtendedLocation	ExtendedLocation は、リソースが作成される Azure カスタムの場所を表します。
ImageRepositoryCredentials	ImageRepositoryCredentials は、イメージ リポジトリへのログインに使用される資格情報を表します。
NetworkAttachment	NetworkAttachment は、単一のネットワーク添付ファイルを表します。
OsDisk	OsDisk は、ブート ディスクの構成を表します。
OsDiskCreateOption	OS ディスクを作成するための戦略。
OsDiskDeleteOption	OS ディスクを削除するための戦略。
SshPublicKey	SshPublicKey は、SSH 経由でリソースで認証するために使用される公開キーを表します。
StorageProfile	StorageProfile は、ディスクに関する情報を表します。
systemData	リソースの作成と最後の変更に関連するメタデータ。
VirtualMachine	VirtualMachine は、オンプレミスのネットワーク クラウド仮想マシンを表します。
VirtualMachineBootMethod	仮想マシンのブート方法を選択します。
VirtualMachineDetailedStatus	仮想マシンのより詳細な状態。
VirtualMachineDeviceModelType	使用するデバイス モデルの種類。
VirtualMachineIPAllocationMethod	仮想マシンの IP 割り当てメカニズム。 動的および静的は、l3Network に対してのみ有効です。また、Disabled を指定することもできます。 それ以外の場合、許可される値は Disabled のみです。
VirtualMachineIsolateEmulatorThread	フィールドは非推奨です。指定された場合、値は無視されます。 この仮想マシンのエミュレーター スレッドを実行するために、指定された CPU コアのいずれかが分離されているかどうかを示すインジケーター。
VirtualMachineList	VirtualMachineList は、仮想マシンの一覧を表します。
VirtualMachinePlacementHint	VirtualMachinePlacementHint は、仮想マシンの単一のスケジューリング ヒントを表します。
VirtualMachinePlacementHintPodAffinityScope	仮想マシンのアフィニティまたはアンチアフィニティ配置ヒントのスコープ。 ノード アフィニティの場合は、常に "マシン" にする必要があります。
VirtualMachinePlacementHintType	このヒントが参照先リソースとのアフィニティまたはアンチアフィニティをサポートするかどうかを指定します。
VirtualMachinePowerState	仮想マシンの電源状態。
VirtualMachineProvisioningState	仮想マシンのプロビジョニング状態。
VirtualMachineSchedulingExecution	スケジュール中にヒントがハード要件かソフト要件かを示すインジケーター。
VirtualMachineVirtioInterfaceType	フィールドは非推奨です。代わりに virtualizationModel を使用してください。 virtio インターフェイスの型。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DefaultGateway

列挙

これが既定のゲートウェイであるかどうかを示すインジケーター。 1 台のマシンに対して接続されているネットワーク (CloudServicesNetwork 添付ファイルを含む) の 1 つだけを True として指定できます。

値	説明
False
True

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

ExtendedLocation

Object

ExtendedLocation は、リソースが作成される Azure カスタムの場所を表します。

名前	型	説明
name	string	リソースが作成される拡張された場所のリソース ID。
type	string	拡張された場所の種類 (CustomLocation など)。

ImageRepositoryCredentials

Object

ImageRepositoryCredentials は、イメージ リポジトリへのログインに使用される資格情報を表します。

名前	型	説明
password	string minLength: 1	ターゲット リポジトリ内のイメージにアクセスするために使用されるパスワードまたはトークン。
registryUrl	string	リポジトリの資格情報の検証に使用される認証サーバーの URL。
username	string minLength: 1	ターゲット リポジトリ内のイメージにアクセスするために使用されるユーザー名。

NetworkAttachment

Object

NetworkAttachment は、単一のネットワーク添付ファイルを表します。

名前	型	説明
attachedNetworkId	string	仮想マシンに接続されている関連付けられているネットワークのリソース ID。 cloudServicesNetwork、l3Network、l2Network、trunkedNetwork のいずれかのリソースを指定できます。
defaultGateway	DefaultGateway	これが既定のゲートウェイであるかどうかを示すインジケーター。 1 台のマシンに対して接続されているネットワーク (CloudServicesNetwork 添付ファイルを含む) の 1 つだけを True として指定できます。
ipAllocationMethod	VirtualMachineIPAllocationMethod	仮想マシンの IP 割り当てメカニズム。 動的および静的は、l3Network に対してのみ有効です。また、Disabled を指定することもできます。 それ以外の場合、許可される値は Disabled のみです。
ipv4Address	string	仮想マシンの IPv4 アドレス。 このフィールドは、接続されているネットワークに IPV4 または DualStack の IPAllocationType がある場合にのみ使用されます。 IPAllocationMethod が Static の場合、このフィールドには、接続されたネットワークで指定されたサブネット内から指定されたユーザー指定の IPv4 アドレスが含まれている必要があります。 動的 - このフィールドは読み取り専用ですが、接続されたネットワークで指定されたサブネット内からアドレスが設定されます。 無効 - このフィールドは空になります。
ipv6Address	string	仮想マシンの IPv6 アドレス。 このフィールドは、接続されているネットワークに IPV6 または DualStack の IPAllocationType がある場合にのみ使用されます。 IPAllocationMethod が Static の場合、このフィールドには、接続されたネットワークで指定された範囲内からの IPv6 アドレス範囲が含まれている必要があります。 動的 - このフィールドは読み取り専用ですが、接続されたネットワークで指定されたサブネット内からの範囲が設定されます。 無効 - このフィールドは空になります。
macAddress	string	このネットワーク添付ファイルに対応する仮想マシンのインターフェイスの MAC アドレス。
networkAttachmentName	string maxLength: 15	関連付けられているネットワークのインターフェイス名。 指定した場合、ネットワーク添付ファイル名の最大長は 15 文字で、この仮想マシンに固有である必要があります。 ユーザーがこの値を指定しない場合は、ネットワーク リソースの既定のインターフェイス名が使用されます。 CloudServicesNetwork リソースの場合、この名前は無視されます。

OsDisk

Object

OsDisk は、ブート ディスクの構成を表します。

名前	型	規定値	説明
createOption	OsDiskCreateOption	Ephemeral	OS ディスクを作成するための戦略。
deleteOption	OsDiskDeleteOption	Delete	OS ディスクを削除するための戦略。
diskSizeGB	integer (int64)		ディスクのサイズ (ギガバイト単位)。 createOption がエフェメラルの場合は必須。

OsDiskCreateOption

列挙

OS ディスクを作成するための戦略。

値	説明
Ephemeral

OsDiskDeleteOption

列挙

OS ディスクを削除するための戦略。

値	説明
Delete

SshPublicKey

Object

SshPublicKey は、SSH 経由でリソースで認証するために使用される公開キーを表します。

名前	型	説明
keyData	string minLength: 1	SSH 公開キー データ。

StorageProfile

Object

StorageProfile は、ディスクに関する情報を表します。

名前	型	説明
osDisk	OsDisk	OsDisk は、ブート ディスクの構成を表します。 この仮想マシンで使用するディスク。
volumeAttachments	string[]	仮想マシンにアタッチするように要求されたボリュームのリソース ID。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

VirtualMachine

Object

VirtualMachine は、オンプレミスのネットワーク クラウド仮想マシンを表します。

名前	型	規定値	説明
extendedLocation	ExtendedLocation		ExtendedLocation は、リソースが作成される Azure カスタムの場所を表します。 リソースに関連付けられているクラスターの拡張された場所。
id	string (arm-id)		リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		リソースが存在する地理的な場所
name	string		リソースの名前
properties.adminUsername	string minLength: 1 maxLength: 32 pattern: ^[a-z_][a-z0-9_]{0,31}$		ssh 公開キーが承認されたキーに追加される管理者の名前。
properties.availabilityZone	string		この仮想マシンを含むクラスター可用性ゾーン。
properties.bareMetalMachineId	string		仮想マシンが上陸したベア メタル マシンのリソース ID。
properties.bootMethod	VirtualMachineBootMethod	UEFI	仮想マシンのブート方法を選択します。
properties.cloudServicesNetworkAttachment	NetworkAttachment		NetworkAttachment は、単一のネットワーク添付ファイルを表します。 仮想マシンのプラットフォーム レベルのサービスを提供するクラウド サービス ネットワーク。
properties.clusterId	string		仮想マシンが作成されるクラスターのリソース ID。
properties.cpuCores	integer (int64) minimum: 2		仮想マシン内の CPU コアの数。
properties.detailedStatus	VirtualMachineDetailedStatus		仮想マシンのより詳細な状態。
properties.detailedStatusMessage	string		現在の詳細な状態に関する説明メッセージ。
properties.isolateEmulatorThread	VirtualMachineIsolateEmulatorThread	True	フィールドは非推奨です。指定された場合、値は無視されます。 この仮想マシンのエミュレーター スレッドを実行するために、指定された CPU コアのいずれかが分離されているかどうかを示すインジケーター。
properties.memorySizeGB	integer (int64) minimum: 1		仮想マシンのメモリ サイズ (GB 単位)。
properties.networkAttachments	NetworkAttachment[]		仮想マシンへのネットワーク添付ファイルの一覧。
properties.networkData	string		Base64 でエンコードされた cloud-init ネットワーク データ。
properties.placementHints	VirtualMachinePlacementHint[]		仮想マシンのスケジュール ヒント。
properties.powerState	VirtualMachinePowerState		仮想マシンの電源状態。
properties.provisioningState	VirtualMachineProvisioningState		仮想マシンのプロビジョニング状態。
properties.sshPublicKeys	SshPublicKey[]		ssh 公開キーの一覧。 各キーは、adminUsername の cloud-init ssh_authorized_keys メカニズムを使用して仮想マシンに追加されます。
properties.storageProfile	StorageProfile		StorageProfile は、ディスクに関する情報を表します。 仮想マシンに関連するディスクに関するサイズやその他のパラメーターを指定するストレージ プロファイル。
properties.userData	string		Base64 でエンコードされた cloud-init ユーザー データ。
properties.virtioInterface	VirtualMachineVirtioInterfaceType	Modern	フィールドは非推奨です。代わりに virtualizationModel を使用してください。 virtio インターフェイスの型。
properties.vmDeviceModel	VirtualMachineDeviceModelType	T2	使用するデバイス モデルの種類。
properties.vmImage	string		イメージのプルに使用される完全な URL とタグ表記を使用して、現在 OS ディスクにプロビジョニングされている仮想マシン イメージ。
properties.vmImageRepositoryCredentials	ImageRepositoryCredentials		ImageRepositoryCredentials は、イメージ リポジトリへのログインに使用される資格情報を表します。 指定したイメージにアクセスできるイメージ リポジトリへのログインに使用される資格情報。
properties.volumes	string[]		仮想マシンに接続されているボリュームのリソース ID。
systemData	systemData		createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object		リソース タグ。
type	string		リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

VirtualMachineBootMethod

列挙

仮想マシンのブート方法を選択します。

値	説明
BIOS
UEFI

VirtualMachineDetailedStatus

列挙

仮想マシンのより詳細な状態。

値	説明
Available
Error
Provisioning
Running
Scheduling
Stopped
Terminating
Unknown

VirtualMachineDeviceModelType

列挙

使用するデバイス モデルの種類。

値	説明
T1
T2

VirtualMachineIPAllocationMethod

列挙

仮想マシンの IP 割り当てメカニズム。 動的および静的は、l3Network に対してのみ有効です。また、Disabled を指定することもできます。 それ以外の場合、許可される値は Disabled のみです。

値	説明
Disabled
Dynamic
Static

VirtualMachineIsolateEmulatorThread

列挙

フィールドは非推奨です。指定された場合、値は無視されます。 この仮想マシンのエミュレーター スレッドを実行するために、指定された CPU コアのいずれかが分離されているかどうかを示すインジケーター。

値	説明
False
True

VirtualMachineList

Object

VirtualMachineList は、仮想マシンの一覧を表します。

名前	型	説明
nextLink	string	操作の次のページを取得するために使用されるリンク。
value	VirtualMachine[]	仮想マシンの一覧。

VirtualMachinePlacementHint

Object

VirtualMachinePlacementHint は、仮想マシンの単一のスケジューリング ヒントを表します。

名前	型	説明
hintType	VirtualMachinePlacementHintType	このヒントが参照先リソースとのアフィニティまたはアンチアフィニティをサポートするかどうかを指定します。
resourceId	string minLength: 1	配置ヒントがチェックされるターゲット オブジェクトのリソース ID (仮想マシンをホストするベア メタル ノードなど)。
schedulingExecution	VirtualMachineSchedulingExecution	スケジュール中にヒントがハード要件かソフト要件かを示すインジケーター。
scope	VirtualMachinePlacementHintPodAffinityScope	仮想マシンのアフィニティまたはアンチアフィニティ配置ヒントのスコープ。 ノード アフィニティの場合は、常に "マシン" にする必要があります。

VirtualMachinePlacementHintPodAffinityScope

列挙

仮想マシンのアフィニティまたはアンチアフィニティ配置ヒントのスコープ。 ノード アフィニティの場合は、常に "マシン" にする必要があります。

値	説明
Machine
Rack

VirtualMachinePlacementHintType

列挙

このヒントが参照先リソースとのアフィニティまたはアンチアフィニティをサポートするかどうかを指定します。

値	説明
Affinity
AntiAffinity

VirtualMachinePowerState

列挙

仮想マシンの電源状態。

値	説明
Off
On
Unknown

VirtualMachineProvisioningState

列挙

仮想マシンのプロビジョニング状態。

値	説明
Accepted
Canceled
Failed
Provisioning
Succeeded

VirtualMachineSchedulingExecution

列挙

スケジュール中にヒントがハード要件かソフト要件かを示すインジケーター。

値	説明
Hard
Soft

VirtualMachineVirtioInterfaceType

列挙

フィールドは非推奨です。代わりに virtualizationModel を使用してください。 virtio インターフェイスの型。

値	説明
Modern
Transitional