Machines - Get

Reference

Service:: Service Map

API Version:: 2015-11-01-preview

Returns the specified machine.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}?api-version=2015-11-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}?api-version=2015-11-01-preview&timestamp={timestamp}

URI Parameters

Name	In	Required	Type	Description
machineName	path	True	string	Machine resource name.
resourceGroupName	path	True	string	Resource group name within the specified subscriptionId. Regex pattern: `[a-zA-Z0-9_-]+`
subscriptionId	path	True	string	Azure subscription identifier.
workspaceName	path	True	string	OMS workspace containing the resources of interest. Regex pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]+[a-zA-Z0-9_]`
api-version	query	True	string	API version.
timestamp	query		string date-time	UTC date and time specifying a time instance relative to which to evaluate the machine resource. When not specified, the service uses DateTime.UtcNow.

Responses

Name	Type	Description
200 OK	Machine	The operation completed successfully.
Other Status Codes	ErrorResponse	An error occurred while processing the request. See the error.code parameter to identify the specific error.

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

SMMachinesGetGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/features/serviceMap/machines/m-A4AB1C69-03E9-42D2-B822-B42555569FB4?api-version=2015-11-01-preview&timestamp=2018-01-07T07:01:16.1556059Z

Sample Response

Status code:: 200

{
  "kind": "machine",
  "properties": {
    "monitoringState": "monitored",
    "virtualizationState": "unknown",
    "displayName": "my machine"
  },
  "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-A4AB1C69-03E9-42D2-B822-B42555569FB4",
  "type": "Microsoft.OperationalInsights/workspaces/features/machines",
  "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
}

Definitions

Name	Description
Accuracy	Specifies the accuracy of a computation.
AgentConfiguration	Describes the configuration of the Dependency Agent installed on a machine.
AzureCloudServiceConfiguration	Describes an Azure Cloud Service
AzureCloudServiceRoleType	Used to specify type of an Azure Cloud Service role
AzureHostingConfiguration	Provides information about how a machine is hosted in Azure
AzureServiceFabricClusterConfiguration	Describes an Azure Service Fabric Cluster
AzureVmScaleSetConfiguration	Describes an Azure Virtual Machine Scale Set
Bitness	Specifies the bitness of a machine or process.
Error	Error details.
ErrorResponse	An error response from the API.
HypervisorConfiguration	Describes the hypervisor configuration of a machine.
HypervisorType	Specifies the hypervisor type of a machine.
ImageConfiguration	Describes the VM image of a machine.
Ipv4NetworkInterface	Describes an IPv4 network interface.
Ipv6NetworkInterface	Describes an IPv6 network interface.
Machine	A machine resource represents a discovered computer system. It can be monitored, i.e., a Dependency Agent is running on it, or discovered, i.e., its existence was inferred by observing the data stream from monitored machines. As machines change, prior versions of the machine resource are preserved and available for access. A machine is live during an interval of time, if either its Dependency Agent has reported data during (parts) of that interval, or a Dependency agent running on other machines has reported activity associated with the machine.
MachineRebootStatus	Specifies if the machine has been rebooted since the installation of the dependency agent.
MachineResourcesConfiguration	Describes the resources of a machine.
MonitoringState	Used to specify if a resources is monitored or discovered.
NetworkConfiguration	Describes the network configuration of a machine.
OperatingSystemConfiguration	Describes the configuration of the operating system of a machine.
OperatingSystemFamily	Specifies the operating system family, e.g., Linux, Windows, etc.
Timezone	Describes a timezone.
VirtualizationState	Specifies if the machine is physical, virtual, hypervisor, or unknown.
VirtualMachineConfiguration	Describes the virtualization-related configuration of a machine.
VirtualMachineType	Specifies the virtualization type of a machine.

Accuracy

Specifies the accuracy of a computation.

Name	Type	Description
actual	string
estimated	string

AgentConfiguration

Describes the configuration of the Dependency Agent installed on a machine.

Name	Type	Description
agentId	string	Health Service Agent unique identifier.
clockGranularity	integer	Machine clock granularity in milliseconds.
dependencyAgentId	string	Dependency Agent unique identifier.
dependencyAgentRevision	string	Dependency Agent revision number.
dependencyAgentVersion	string	Dependency Agent version number.
rebootStatus	MachineRebootStatus	Specifies whether the machine has been rebooted since the Dependency Agent installation.

AzureCloudServiceConfiguration

Describes an Azure Cloud Service

Name	Type	Description
deployment	string	Cloud Service deployment identifier
instanceId	string	Cloud Service instance identifier
name	string	Cloud Service name
roleName	string	Cloud Service role name
roleType	AzureCloudServiceRoleType	Used to specify type of an Azure Cloud Service role

AzureCloudServiceRoleType

Used to specify type of an Azure Cloud Service role

Name	Type	Description
unknown	string
web	string
worker	string

AzureHostingConfiguration

Provides information about how a machine is hosted in Azure

Name	Type	Description
cloudService	AzureCloudServiceConfiguration	Contains information about machines hosted as an Azure Cloud Service
faultDomain	string	Fault domain of the VM.
image	ImageConfiguration	Image of the machine.
kind	string: provider:azure	Additional hosting configuration type qualifier.
location	string	Geographical location of the VM.
name	string	Machine name according to the hosting provider.
provider	enum: azure	The hosting provider of the VM.
resourceGroup	string	Resource group name within the specified subscription.
resourceId	string	Unique identifier of the resource.
serviceFabricCluster	AzureServiceFabricClusterConfiguration	Contains information about machines that belong an Azure Service Fabric Cluster
size	string	Size of the VM.
subscriptionId	string	Subscription ID.
updateDomain	string	Update domain of the VM.
vmId	string	Virtual Machine ID (unique identifier).
vmScaleSet	AzureVmScaleSetConfiguration	Contains information about machines hosted as an Azure Virtual Machine Scale Set

AzureServiceFabricClusterConfiguration

Describes an Azure Service Fabric Cluster

Name	Type	Description
clusterId	string	Service Fabric cluster identifier.
name	string	Service Fabric cluster name.

AzureVmScaleSetConfiguration

Describes an Azure Virtual Machine Scale Set

Name	Type	Description
deployment	string	Virtual Machine Scale Set deployment identifier
instanceId	string	Virtual Machine Scale Set instance identifier
name	string	Virtual Machine Scale Set name
resourceId	string	Unique identifier of the resource.

Bitness

Specifies the bitness of a machine or process.

Name	Type	Description
32bit	string
64bit	string

Error

Error details.

Name	Type	Description
code	string	Error code identifying the specific error.
message	string	Error message in the caller's locale.

ErrorResponse

An error response from the API.

Name	Type	Description
error	Error	Error information.

HypervisorConfiguration

Describes the hypervisor configuration of a machine.

Name	Type	Description
hypervisorType	HypervisorType	Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.)
nativeHostMachineId	string	The unique identifier of the hypervisor machine as reported by the underlying virtualization system.

HypervisorType

Specifies the hypervisor type of a machine.

Name	Type	Description
hyperv	string
unknown	string

ImageConfiguration

Describes the VM image of a machine.

Name	Type	Description
offering	string	Offering of the VM image.
publisher	string	Publisher of the VM image.
sku	string	SKU of the VM image.
version	string	Version of the VM image.

Ipv4NetworkInterface

Describes an IPv4 network interface.

Name	Type	Default Value	Description
ipAddress	string		IPv4 address.
subnetMask	string	255.255.255.255	IPv4 subnet mask.

Ipv6NetworkInterface

Describes an IPv6 network interface.

Name	Type	Description
ipAddress	string	IPv6 address.

Machine

A machine resource represents a discovered computer system. It can be monitored, i.e., a Dependency Agent is running on it, or discovered, i.e., its existence was inferred by observing the data stream from monitored machines. As machines change, prior versions of the machine resource are preserved and available for access. A machine is live during an interval of time, if either its Dependency Agent has reported data during (parts) of that interval, or a Dependency agent running on other machines has reported activity associated with the machine.

Name	Type	Description
etag	string	Resource ETAG.
id	string	Resource identifier.
kind	string: machine	Additional resource type qualifier.
name	string	Resource name.
properties.agent	AgentConfiguration	Dependency Agent configuration.
properties.bootTime	string	UTC date and time when the machine last booted
properties.computerName	string	Name of the machine, e.g., server
properties.displayName	string	Name to use for display purposes
properties.fullyQualifiedDomainName	string	Fully-qualified name of the machine, e.g., server.company.com
properties.hosting	HostingConfiguration: AzureHostingConfiguration	Hosting-related configuration. Present if hosting information is discovered for the VM.
properties.hypervisor	HypervisorConfiguration	Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`.
properties.monitoringState	MonitoringState	Specifies whether the machine is actively monitored or discovered.
properties.networking	NetworkConfiguration	Network configuration (ips, gateways, dns, etc.)
properties.operatingSystem	OperatingSystemConfiguration	Operating system information.
properties.resources	MachineResourcesConfiguration	Machine resources (memory, cpu, etc.).
properties.timestamp	string	UTC date and time when this resource was updated in the system.
properties.timezone	Timezone	Timezone of the machine.
properties.virtualMachine	VirtualMachineConfiguration	Virtualization-related configuration. Present only when `virtualizationState` is `virtual`.
properties.virtualizationState	VirtualizationState	Specifies whether the machine is virtualized.
type	string	Resource type.

MachineRebootStatus

Specifies if the machine has been rebooted since the installation of the dependency agent.

Name	Type	Description
notRebooted	string
rebooted	string
unknown	string

MachineResourcesConfiguration

Describes the resources of a machine.

Name	Type	Description
cpuSpeed	integer	CPU speed in megahertz (Mhz).
cpuSpeedAccuracy	Accuracy	Describes the accuracy of the cpuSpeed field.
cpus	integer	Number of CPUs.
physicalMemory	integer	Physical memory in megabytes (MB).

MonitoringState

Used to specify if a resources is monitored or discovered.

Name	Type	Description
discovered	string
monitored	string

NetworkConfiguration

Describes the network configuration of a machine.

Name	Type	Description
defaultIpv4Gateways	string[]	Default IPv4 gateways.
dnsNames	string[]	DNS names associated with the machine.
ipv4Interfaces	Ipv4NetworkInterface[]	IPv4 interfaces.
ipv6Interfaces	Ipv6NetworkInterface[]	IPv6 interfaces.
macAddresses	string[]	MAC addresses of all active network interfaces.

OperatingSystemConfiguration

Describes the configuration of the operating system of a machine.

Name	Type	Description
bitness	Bitness	Operating system bitness (32-bit or 64-bit).
family	OperatingSystemFamily	Windows, Linux, etc.
fullName	string	Operating system full name.

OperatingSystemFamily

Specifies the operating system family, e.g., Linux, Windows, etc.

Name	Type	Description
aix	string
linux	string
solaris	string
unknown	string
windows	string

Timezone

Describes a timezone.

Name	Type	Description
fullName	string	Timezone full name.

VirtualizationState

Specifies if the machine is physical, virtual, hypervisor, or unknown.

Name	Type	Description
hypervisor	string
physical	string
unknown	string
virtual	string

VirtualMachineConfiguration

Describes the virtualization-related configuration of a machine.

Name	Type	Description
nativeHostMachineId	string	The unique identifier of the host of this virtual machine as reported by the underlying virtualization system.
nativeMachineId	string	The unique identifier of the virtual machine as reported by the underlying virtualization system.
virtualMachineName	string	The Name of the virtual machine.
virtualMachineType	VirtualMachineType	Specifies the virtualization technology used by the machine (hyperv, vmware, etc.)

VirtualMachineType

Specifies the virtualization type of a machine.

Name	Type	Description
hyperv	string
ldom	string
lpar	string
unknown	string
virtualPc	string
vmware	string
xen	string

Share via