Machines - Get

Service:

Azure Migrate

API Version:

2019-10-01

Get a specific machine.
Get the machine with the specified name. Returns a json object of type 'machine' defined in Models section.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}?api-version=2019-10-01

URI Parameters

Name	In	Required	Type	Description
machineName	path	True	string	Unique name of a machine in private datacenter.
projectName	path	True	string	Name of the Azure Migrate project.
resourceGroupName	path	True	string	Name of the Azure Resource Group that project is part of.
subscriptionId	path	True	string	Azure Subscription Id in which project was created.
api-version	query	True	string	Standard request header. Used by service to identify API version used by client.

Responses

Name	Type	Description
200 OK	Machine	OK. Returns the machine with the specified name. Headers x-ms-request-id: string
Other Status Codes	CloudError	Error response describing why the operation failed.

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

Machines_Get

Sample Request

HTTP

GET https://management.azure.com/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westEurope/providers/Microsoft.Migrate/assessmentProjects/abgoyalWEselfhostb72bproject/machines/269ef295-a38d-4f8f-9779-77ce79088311?api-version=2019-10-01

Go

package armmigrate_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/migrate/armmigrate"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Machines_Get.json
func ExampleMachinesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmigrate.NewMachinesClient("6393a73f-8d55-47ef-b6dd-179b3e0c7910", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"abgoyal-westEurope",
		"abgoyalWEselfhostb72bproject",
		"269ef295-a38d-4f8f-9779-77ce79088311",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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

/**
 * This sample demonstrates how to Get the machine with the specified name. Returns a json object of type 'machine' defined in Models section.
 *
 * @summary Get the machine with the specified name. Returns a json object of type 'machine' defined in Models section.
 * x-ms-original-file: specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Machines_Get.json
 */
async function machinesGet() {
  const subscriptionId =
    process.env["MIGRATE_SUBSCRIPTION_ID"] || "6393a73f-8d55-47ef-b6dd-179b3e0c7910";
  const resourceGroupName = process.env["MIGRATE_RESOURCE_GROUP"] || "abgoyal-westEurope";
  const projectName = "abgoyalWEselfhostb72bproject";
  const machineName = "269ef295-a38d-4f8f-9779-77ce79088311";
  const credential = new DefaultAzureCredential();
  const client = new AzureMigrateV2(credential, subscriptionId);
  const result = await client.machines.get(resourceGroupName, projectName, machineName);
  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/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westeurope/providers/Microsoft.Migrate/assessmentprojects/abgoyalWEselfhostb72bproject/machines/269ef295-a38d-4f8f-9779-77ce79088311",
  "name": "269ef295-a38d-4f8f-9779-77ce79088311",
  "type": "Microsoft.Migrate/assessmentprojects/machines",
  "eTag": "\"04006052-0000-0d00-0000-5cd4065a0000\"",
  "properties": {
    "discoveryMachineArmId": "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourcegroups/abgoyal-westeurope/providers/microsoft.offazure/vmwaresites/portalvcenterbc2fsite/machines/idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_52bd4eeb-faf4-7d95-4dd5-5524350ce2bb",
    "datacenterManagementServerArmId": "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westEurope/providers/Microsoft.OffAzure/VMwareSites/PortalvCenterbc2fsite/vcenters/idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3",
    "datacenterManagementServerName": "IDCLAB-A360.fareast.corp.microsoft.com",
    "bootType": "BIOS",
    "displayName": "ShubhamFirstAndThird",
    "megabytesOfMemory": 16384,
    "numberOfCores": 8,
    "operatingSystemType": "windowsGuest",
    "operatingSystemName": "Microsoft Windows Server 2016 (64-bit)",
    "operatingSystemVersion": null,
    "description": "Microsoft Azure Migration Image on Windows Server 2016",
    "createdTimestamp": "2019-05-09T09:58:22.1734149Z",
    "disks": {
      "6000C29f-9065-8fe0-ab83-7e58ff6ba442": {
        "gigabytesAllocated": 80,
        "displayName": "scsi0:0"
      }
    },
    "groups": [
      "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westeurope/providers/Microsoft.Migrate/assessmentprojects/abgoyalWEselfhostb72bproject/groups/test1"
    ],
    "networkAdapters": {
      "4000": {
        "macAddress": "00:0c:29:ac:e3:6d",
        "ipAddresses": [],
        "displayName": "VM Network"
      }
    },
    "updatedTimestamp": "2019-05-09T09:58:22.2990529Z"
  }
}

Definitions

CloudError	An error response from the Azure Migrate service.
CloudErrorBody	An error response from the Azure Migrate service.
Disk	A disk discovered on a machine.
Machine	A machine in a migration project.
MachineBootType	Boot type of the machine.
MachineProperties	Properties of a machine.
NetworkAdapter	A network adapter discovered on a machine.

CloudError

An error response from the Azure Migrate service.

Name	Type	Description
error	CloudErrorBody	An error response from the Azure Migrate service.

CloudErrorBody

An error response from the Azure Migrate service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

Disk

A disk discovered on a machine.

Name	Type	Description
displayName	string	User friendly name of the disk.
gigabytesAllocated	number	Gigabytes of storage provisioned for this disk.

Machine

A machine in a migration project.

Name	Type	Description
eTag	string	For optimistic concurrency control.
id	string	Path reference to this machine. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}
name	string	Name of the machine. It is a GUID which is unique identifier of machine in private data center. For user-readable name, we have a displayName property on this machine.
properties	MachineProperties	Properties of the machine.
type	string	Type of the object = [Microsoft.Migrate/assessmentProjects/machines].

MachineBootType

Boot type of the machine.

Name	Type	Description
BIOS	string
EFI	string
Unknown	string

MachineProperties

Properties of a machine.

Name	Type	Description
bootType	MachineBootType	Boot type of the machine.
createdTimestamp	string	Time when this machine was created. Date-Time represented in ISO-8601 format.
datacenterManagementServerArmId	string	ARM ID of the data center as tracked by the Microsoft.OffAzure.
datacenterManagementServerName	string	Name of the server hosting the datacenter management solution.
description	string	Description of the machine
discoveryMachineArmId	string	ARM ID of the machine as tracked by the Microsoft.OffAzure.
disks	<string,  Disk>	Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object
displayName	string	User readable name of the machine as defined by the user in their private datacenter.
groups	string[]	List of references to the groups that the machine is member of.
megabytesOfMemory	number	Memory in Megabytes.
networkAdapters	<string,  NetworkAdapter>	Dictionary of network adapters attached to the machine. Key is ID of network adapter. Value is a network adapter object
numberOfCores	integer	Processor count.
operatingSystemName	string	Operating System name of the machine.
operatingSystemType	string	Operating System type of the machine.
operatingSystemVersion	string	Operating System version of the machine.
updatedTimestamp	string	Time when this machine was last updated. Date-Time represented in ISO-8601 format.

NetworkAdapter

A network adapter discovered on a machine.

Name	Type	Description
displayName	string	User friendly name of the network adapter.
ipAddresses	string[]	List of IP Addresses on the network adapter.
macAddress	string	MAC Address of the network adapter.