Microsoft.OperationalInsights (preview:2015-11-01)

2025/09/26 • 25 new, 25 deleted methods

Machines_ListByWorkspace (new)
Description :  Returns a collection of machines matching the specified conditions. The returned collection represents either machines that are active/live during the specified interval of time (`live=true` and `startTime`/`endTime` are specified) or that are known to have existed at or some time prior to the specified point in time (`live=false` and `timestamp` is specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
live:
{
Description: Specifies whether to return live resources (true) or inventory resources (false). Defaults to **true**. When retrieving live resources, the start time (`startTime`) and end time (`endTime`) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (`timestamp`) parameter can be specified to return the version of each resource closest (not-after) that timestamp. ,
Required: False ,
}
boolean ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate each machine resource. Only applies when `live=false`. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
$top:
{
Description: Page size to use. When not specified, the default page size is 100 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Machine resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this resource was updated in the system. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the machine is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
virtualizationState:
{
Description: Specifies whether the machine is virtualized. ,
Enum:
{
unknown: No description available. ,
physical: No description available. ,
virtual: No description available. ,
hypervisor: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
computerName:
{
Description: Name of the machine, e.g., server ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: Fully-qualified name of the machine, e.g., server.company.com ,
Required: False ,
}
string ,
bootTime:
{
Description: UTC date and time when the machine last booted ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: Timezone of the machine. ,
Required: False ,
}
{
fullName:
{
Description: Timezone full name. ,
Required: False ,
}
string ,
}
,
agent:
{
Description: Dependency Agent configuration. ,
Required: False ,
}
{
agentId:
{
Description: Health Service Agent unique identifier. ,
Required: True ,
}
string ,
dependencyAgentId:
{
Description: Dependency Agent unique identifier. ,
Required: False ,
}
string ,
dependencyAgentVersion:
{
Description: Dependency Agent version number. ,
Required: False ,
}
string ,
dependencyAgentRevision:
{
Description: Dependency Agent revision number. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: Specifies whether the machine has been rebooted since the Dependency Agent installation. ,
Enum:
{
unknown: No description available. ,
rebooted: No description available. ,
notRebooted: No description available. ,
}
,
Required: False ,
}
enum ,
clockGranularity:
{
Description: Machine clock granularity in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
resources:
{
Description: Machine resources (memory, cpu, etc.). ,
Required: False ,
}
{
physicalMemory:
{
Description: Physical memory in megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
cpus:
{
Description: Number of CPUs. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeed:
{
Description: CPU speed in megahertz (Mhz). ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeedAccuracy:
{
Description: Describes the accuracy of the cpuSpeed field. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networking:
{
Description: Network configuration (ips, gateways, dns, etc.) ,
Required: False ,
}
{
ipv4Interfaces:
{
Description: IPv4 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv4 address. ,
Required: True ,
}
string ,
subnetMask:
{
Description: IPv4 subnet mask. ,
Required: False ,
}
string ,
}
,
]
,
ipv6Interfaces:
{
Description: IPv6 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv6 address. ,
Required: True ,
}
string ,
}
,
]
,
defaultIpv4Gateways:
{
Description: Default IPv4 gateways. ,
Required: False ,
}
[
string ,
]
,
macAddresses:
{
Description: MAC addresses of all active network interfaces. ,
Required: False ,
}
[
string ,
]
,
dnsNames:
{
Description: DNS names associated with the machine. ,
Required: False ,
}
[
string ,
]
,
}
,
operatingSystem:
{
Description: Operating system information. ,
Required: False ,
}
{
family:
{
Description: Windows, Linux, etc. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: True ,
}
enum ,
fullName:
{
Description: Operating system full name. ,
Required: True ,
}
string ,
bitness:
{
Description: Operating system bitness (32-bit or 64-bit). ,
Enum:
{
32bit: No description available. ,
64bit: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
virtualMachine:
{
Description: Virtualization-related configuration. Present only when `virtualizationState` is `virtual`. ,
Required: False ,
}
{
virtualMachineType:
{
Description: Specifies the virtualization technology used by the machine (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
ldom: No description available. ,
lpar: No description available. ,
vmware: No description available. ,
virtualPc: No description available. ,
xen: No description available. ,
}
,
Required: False ,
}
enum ,
nativeMachineId:
{
Description: The unique identifier of the virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
virtualMachineName:
{
Description: The Name of the virtual machine. ,
Required: False ,
}
string ,
nativeHostMachineId:
{
Description: The unique identifier of the host of this virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hypervisor:
{
Description: Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`. ,
Required: False ,
}
{
hypervisorType:
{
Description: Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
}
,
Required: False ,
}
enum ,
nativeHostMachineId:
{
Description: The unique identifier of the hypervisor machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hosting:
{
Description: Hosting-related configuration. Present if hosting information is discovered for the VM. ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_Get (new)
Description :  Returns the specified machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate the machine resource. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this resource was updated in the system. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the machine is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
virtualizationState:
{
Description: Specifies whether the machine is virtualized. ,
Enum:
{
unknown: No description available. ,
physical: No description available. ,
virtual: No description available. ,
hypervisor: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
computerName:
{
Description: Name of the machine, e.g., server ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: Fully-qualified name of the machine, e.g., server.company.com ,
Required: False ,
}
string ,
bootTime:
{
Description: UTC date and time when the machine last booted ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: Timezone of the machine. ,
Required: False ,
}
{
fullName:
{
Description: Timezone full name. ,
Required: False ,
}
string ,
}
,
agent:
{
Description: Dependency Agent configuration. ,
Required: False ,
}
{
agentId:
{
Description: Health Service Agent unique identifier. ,
Required: True ,
}
string ,
dependencyAgentId:
{
Description: Dependency Agent unique identifier. ,
Required: False ,
}
string ,
dependencyAgentVersion:
{
Description: Dependency Agent version number. ,
Required: False ,
}
string ,
dependencyAgentRevision:
{
Description: Dependency Agent revision number. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: Specifies whether the machine has been rebooted since the Dependency Agent installation. ,
Enum:
{
unknown: No description available. ,
rebooted: No description available. ,
notRebooted: No description available. ,
}
,
Required: False ,
}
enum ,
clockGranularity:
{
Description: Machine clock granularity in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
resources:
{
Description: Machine resources (memory, cpu, etc.). ,
Required: False ,
}
{
physicalMemory:
{
Description: Physical memory in megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
cpus:
{
Description: Number of CPUs. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeed:
{
Description: CPU speed in megahertz (Mhz). ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeedAccuracy:
{
Description: Describes the accuracy of the cpuSpeed field. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networking:
{
Description: Network configuration (ips, gateways, dns, etc.) ,
Required: False ,
}
{
ipv4Interfaces:
{
Description: IPv4 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv4 address. ,
Required: True ,
}
string ,
subnetMask:
{
Description: IPv4 subnet mask. ,
Required: False ,
}
string ,
}
,
]
,
ipv6Interfaces:
{
Description: IPv6 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv6 address. ,
Required: True ,
}
string ,
}
,
]
,
defaultIpv4Gateways:
{
Description: Default IPv4 gateways. ,
Required: False ,
}
[
string ,
]
,
macAddresses:
{
Description: MAC addresses of all active network interfaces. ,
Required: False ,
}
[
string ,
]
,
dnsNames:
{
Description: DNS names associated with the machine. ,
Required: False ,
}
[
string ,
]
,
}
,
operatingSystem:
{
Description: Operating system information. ,
Required: False ,
}
{
family:
{
Description: Windows, Linux, etc. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: True ,
}
enum ,
fullName:
{
Description: Operating system full name. ,
Required: True ,
}
string ,
bitness:
{
Description: Operating system bitness (32-bit or 64-bit). ,
Enum:
{
32bit: No description available. ,
64bit: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
virtualMachine:
{
Description: Virtualization-related configuration. Present only when `virtualizationState` is `virtual`. ,
Required: False ,
}
{
virtualMachineType:
{
Description: Specifies the virtualization technology used by the machine (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
ldom: No description available. ,
lpar: No description available. ,
vmware: No description available. ,
virtualPc: No description available. ,
xen: No description available. ,
}
,
Required: False ,
}
enum ,
nativeMachineId:
{
Description: The unique identifier of the virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
virtualMachineName:
{
Description: The Name of the virtual machine. ,
Required: False ,
}
string ,
nativeHostMachineId:
{
Description: The unique identifier of the host of this virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hypervisor:
{
Description: Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`. ,
Required: False ,
}
{
hypervisorType:
{
Description: Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
}
,
Required: False ,
}
enum ,
nativeHostMachineId:
{
Description: The unique identifier of the hypervisor machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hosting:
{
Description: Hosting-related configuration. Present if hosting information is discovered for the VM. ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_GetLiveness (new)
Description :  Obtains the liveness status of the machine during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/liveness
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Liveness interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Liveness interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
live:
{
Description: `true` if the resource is live during [startTime, endTime], `false` otherwise ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListConnections (new)
Description :  Returns a collection of connections terminating or originating at the specified machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/connections
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListProcesses (new)
Description :  Returns a collection of processes on the specified machine matching the specified conditions. The returned collection represents either processes that are active/live during the specified interval of time (`live=true` and `startTime`/`endTime` are specified) or that are known to have existed at or some time prior to the specified point in time (`live=false` and `timestamp` is specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
live:
{
Description: Specifies whether to return live resources (true) or inventory resources (false). Defaults to **true**. When retrieving live resources, the start time (`startTime`) and end time (`endTime`) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (`timestamp`) parameter can be specified to return the version of each resource closest (not-after) that timestamp. ,
Required: False ,
}
boolean ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate all process resource. Only applies when `live=false`. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Process resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_Get (new)
Description :  Returns the specified process.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate a resource. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_GetLiveness (new)
Description :  Obtains the liveness status of the process during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/liveness
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Liveness interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Liveness interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
live:
{
Description: `true` if the resource is live during [startTime, endTime], `false` otherwise ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_ListAcceptingPorts (new)
Description :  Returns a collection of ports on which this process is accepting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/acceptingPorts
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Port resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_ListConnections (new)
Description :  Returns a collection of connections terminating or originating at the specified process
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/connections
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListPorts (new)
Description :  Returns a collection of live ports on the specified machine during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Port resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_Get (new)
Description :  Returns the specified port. The port must be live during the specified time interval. If the port is not live during the interval, status 404 (Not Found) is returned.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_GetLiveness (new)
Description :  Obtains the liveness status of the port during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/liveness
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Liveness interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Liveness interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
live:
{
Description: `true` if the resource is live during [startTime, endTime], `false` otherwise ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_ListAcceptingProcesses (new)
Description :  Returns a collection of processes accepting on the specified port
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/acceptingProcesses
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Process resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_ListConnections (new)
Description :  Returns a collection of connections established via the specified port.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/connections
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListMachineGroupMembership (new)
Description :  Returns a collection of machine groups this machine belongs to during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/machineGroups
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Machine Group resources. ,
Required: False ,
}
[
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
ClientGroups_Get (new)
Description :  Retrieves the specified client group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Client Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
clientsOf:
{
Description: Reference to the resource whose clients are represented by this group. ,
Required: True ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
ClientGroups_GetMembersCount (new)
Description :  Returns the approximate number of members in the client group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/membersCount
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Client Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Membership interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Membership interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
groupId:
{
Description: Client Group URI. ,
Required: True ,
}
string ,
count:
{
Description: Number of members in the client group. Use this value together with the value of ```accuracy```. If accuracy is `exact` then the value represents the actual number of members in the cloud. When accuracy is `estimated`, the actual number of members is larger than the value of ```count```. ,
Format: int32 ,
Required: True ,
}
integer ,
accuracy:
{
Description: Accuracy of the reported count. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
ClientGroups_ListMembers (new)
Description :  Returns the members of the client group during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/members
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Client Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
$top:
{
Description: Page size to use. When not specified, the default page size is 100 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Collection of ClientGroupMember resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address. ,
Required: False ,
}
string ,
port:
{
Description: Port into which this client connected ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
processes:
{
Description: Processes accepting on the above port that received connections from this client. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the process. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Maps_Generate (new)
Description :  Generates the specified map.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/generateMap
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
request:
{
Description: Request options. ,
Required: True ,
}
{
startTime:
{
Description: Map interval start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Map interval end time. ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: The type of map to create. ,
Enum:
{
map:single-machine-dependency: No description available. ,
map:machine-group-dependency: No description available. ,
map:machine-list-dependency: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
startTime:
{
Description: Map interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Map interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
map:
{
Description: The generated map. ,
Required: True ,
}
{
nodes:
{
Description: The nodes (entities) of a map. ,
Required: True ,
}
{
machines:
{
Description: Machine resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this resource was updated in the system. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the machine is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
virtualizationState:
{
Description: Specifies whether the machine is virtualized. ,
Enum:
{
unknown: No description available. ,
physical: No description available. ,
virtual: No description available. ,
hypervisor: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
computerName:
{
Description: Name of the machine, e.g., server ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: Fully-qualified name of the machine, e.g., server.company.com ,
Required: False ,
}
string ,
bootTime:
{
Description: UTC date and time when the machine last booted ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: Timezone of the machine. ,
Required: False ,
}
{
fullName:
{
Description: Timezone full name. ,
Required: False ,
}
string ,
}
,
agent:
{
Description: Dependency Agent configuration. ,
Required: False ,
}
{
agentId:
{
Description: Health Service Agent unique identifier. ,
Required: True ,
}
string ,
dependencyAgentId:
{
Description: Dependency Agent unique identifier. ,
Required: False ,
}
string ,
dependencyAgentVersion:
{
Description: Dependency Agent version number. ,
Required: False ,
}
string ,
dependencyAgentRevision:
{
Description: Dependency Agent revision number. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: Specifies whether the machine has been rebooted since the Dependency Agent installation. ,
Enum:
{
unknown: No description available. ,
rebooted: No description available. ,
notRebooted: No description available. ,
}
,
Required: False ,
}
enum ,
clockGranularity:
{
Description: Machine clock granularity in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
resources:
{
Description: Machine resources (memory, cpu, etc.). ,
Required: False ,
}
{
physicalMemory:
{
Description: Physical memory in megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
cpus:
{
Description: Number of CPUs. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeed:
{
Description: CPU speed in megahertz (Mhz). ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeedAccuracy:
{
Description: Describes the accuracy of the cpuSpeed field. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networking:
{
Description: Network configuration (ips, gateways, dns, etc.) ,
Required: False ,
}
{
ipv4Interfaces:
{
Description: IPv4 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv4 address. ,
Required: True ,
}
string ,
subnetMask:
{
Description: IPv4 subnet mask. ,
Required: False ,
}
string ,
}
,
]
,
ipv6Interfaces:
{
Description: IPv6 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv6 address. ,
Required: True ,
}
string ,
}
,
]
,
defaultIpv4Gateways:
{
Description: Default IPv4 gateways. ,
Required: False ,
}
[
string ,
]
,
macAddresses:
{
Description: MAC addresses of all active network interfaces. ,
Required: False ,
}
[
string ,
]
,
dnsNames:
{
Description: DNS names associated with the machine. ,
Required: False ,
}
[
string ,
]
,
}
,
operatingSystem:
{
Description: Operating system information. ,
Required: False ,
}
{
family:
{
Description: Windows, Linux, etc. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: True ,
}
enum ,
fullName:
{
Description: Operating system full name. ,
Required: True ,
}
string ,
bitness:
{
Description: Operating system bitness (32-bit or 64-bit). ,
Enum:
{
32bit: No description available. ,
64bit: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
virtualMachine:
{
Description: Virtualization-related configuration. Present only when `virtualizationState` is `virtual`. ,
Required: False ,
}
{
virtualMachineType:
{
Description: Specifies the virtualization technology used by the machine (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
ldom: No description available. ,
lpar: No description available. ,
vmware: No description available. ,
virtualPc: No description available. ,
xen: No description available. ,
}
,
Required: False ,
}
enum ,
nativeMachineId:
{
Description: The unique identifier of the virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
virtualMachineName:
{
Description: The Name of the virtual machine. ,
Required: False ,
}
string ,
nativeHostMachineId:
{
Description: The unique identifier of the host of this virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hypervisor:
{
Description: Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`. ,
Required: False ,
}
{
hypervisorType:
{
Description: Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
}
,
Required: False ,
}
enum ,
nativeHostMachineId:
{
Description: The unique identifier of the hypervisor machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hosting:
{
Description: Hosting-related configuration. Present if hosting information is discovered for the VM. ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
processes:
{
Description: Process resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
ports:
{
Description: Port resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
clientGroups:
{
Description: Client Group resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
clientsOf:
{
Description: Reference to the resource whose clients are represented by this group. ,
Required: True ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
}
,
edges:
{
Description: The edges (relationships) of a map. ,
Required: True ,
}
{
connections:
{
Description: Network connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
acceptors:
{
Description: Processes accepting on a port. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for an acceptor relationship. ,
Required: False ,
}
{
source:
{
Description: Port being accepted. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
destination:
{
Description: Accepting process. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the process. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: Relationship start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Relationship end time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Summaries_GetMachines (new)
Description :  Returns summary information about the machines in the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/summaries/machines
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Summarizes machines in the workspace. ,
Required: False ,
}
{
total:
{
Description: Total number of machines. ,
Format: int32 ,
Required: True ,
}
integer ,
live:
{
Description: Number of live machines. ,
Format: int32 ,
Required: True ,
}
integer ,
os:
{
Description: Machine counts by operating system. ,
Required: True ,
}
{
windows:
{
Description: Number of live Windows machines. ,
Format: int32 ,
Required: True ,
}
integer ,
linux:
{
Description: Number of live Linux machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_ListByWorkspace (new)
Description :  Returns all machine groups during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Machine Group resources. ,
Required: False ,
}
[
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Create (new)
Description :  Creates a new machine group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroup:
{
Description: Machine Group resource to create. ,
Required: True ,
}
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Get (new)
Description :  Returns the specified machine group as it existed during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroupName:
{
Description: Machine Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Update (new)
Description :  Updates a machine group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroupName:
{
Description: Machine Group resource name. ,
Required: True ,
}
string ,
machineGroup:
{
Description: Machine Group resource to update. ,
Required: True ,
}
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Delete (new)
Description :  Deletes the specified Machine Group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroupName:
{
Description: Machine Group resource name. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListByWorkspace (removed)
Description :  Returns a collection of machines matching the specified conditions. The returned collection represents either machines that are active/live during the specified interval of time (`live=true` and `startTime`/`endTime` are specified) or that are known to have existed at or some time prior to the specified point in time (`live=false` and `timestamp` is specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
live:
{
Description: Specifies whether to return live resources (true) or inventory resources (false). Defaults to **true**. When retrieving live resources, the start time (`startTime`) and end time (`endTime`) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (`timestamp`) parameter can be specified to return the version of each resource closest (not-after) that timestamp. ,
Required: False ,
}
boolean ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate each machine resource. Only applies when `live=false`. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
$top:
{
Description: Page size to use. When not specified, the default page size is 100 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Machine resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this resource was updated in the system. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the machine is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
virtualizationState:
{
Description: Specifies whether the machine is virtualized. ,
Enum:
{
unknown: No description available. ,
physical: No description available. ,
virtual: No description available. ,
hypervisor: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
computerName:
{
Description: Name of the machine, e.g., server ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: Fully-qualified name of the machine, e.g., server.company.com ,
Required: False ,
}
string ,
bootTime:
{
Description: UTC date and time when the machine last booted ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: Timezone of the machine. ,
Required: False ,
}
{
fullName:
{
Description: Timezone full name. ,
Required: False ,
}
string ,
}
,
agent:
{
Description: Dependency Agent configuration. ,
Required: False ,
}
{
agentId:
{
Description: Health Service Agent unique identifier. ,
Required: True ,
}
string ,
dependencyAgentId:
{
Description: Dependency Agent unique identifier. ,
Required: False ,
}
string ,
dependencyAgentVersion:
{
Description: Dependency Agent version number. ,
Required: False ,
}
string ,
dependencyAgentRevision:
{
Description: Dependency Agent revision number. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: Specifies whether the machine has been rebooted since the Dependency Agent installation. ,
Enum:
{
unknown: No description available. ,
rebooted: No description available. ,
notRebooted: No description available. ,
}
,
Required: False ,
}
enum ,
clockGranularity:
{
Description: Machine clock granularity in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
resources:
{
Description: Machine resources (memory, cpu, etc.). ,
Required: False ,
}
{
physicalMemory:
{
Description: Physical memory in megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
cpus:
{
Description: Number of CPUs. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeed:
{
Description: CPU speed in megahertz (Mhz). ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeedAccuracy:
{
Description: Describes the accuracy of the cpuSpeed field. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networking:
{
Description: Network configuration (ips, gateways, dns, etc.) ,
Required: False ,
}
{
ipv4Interfaces:
{
Description: IPv4 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv4 address. ,
Required: True ,
}
string ,
subnetMask:
{
Description: IPv4 subnet mask. ,
Required: False ,
}
string ,
}
,
]
,
ipv6Interfaces:
{
Description: IPv6 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv6 address. ,
Required: True ,
}
string ,
}
,
]
,
defaultIpv4Gateways:
{
Description: Default IPv4 gateways. ,
Required: False ,
}
[
string ,
]
,
macAddresses:
{
Description: MAC addresses of all active network interfaces. ,
Required: False ,
}
[
string ,
]
,
dnsNames:
{
Description: DNS names associated with the machine. ,
Required: False ,
}
[
string ,
]
,
}
,
operatingSystem:
{
Description: Operating system information. ,
Required: False ,
}
{
family:
{
Description: Windows, Linux, etc. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: True ,
}
enum ,
fullName:
{
Description: Operating system full name. ,
Required: True ,
}
string ,
bitness:
{
Description: Operating system bitness (32-bit or 64-bit). ,
Enum:
{
32bit: No description available. ,
64bit: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
virtualMachine:
{
Description: Virtualization-related configuration. Present only when `virtualizationState` is `virtual`. ,
Required: False ,
}
{
virtualMachineType:
{
Description: Specifies the virtualization technology used by the machine (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
ldom: No description available. ,
lpar: No description available. ,
vmware: No description available. ,
virtualPc: No description available. ,
xen: No description available. ,
}
,
Required: False ,
}
enum ,
nativeMachineId:
{
Description: The unique identifier of the virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
virtualMachineName:
{
Description: The Name of the virtual machine. ,
Required: False ,
}
string ,
nativeHostMachineId:
{
Description: The unique identifier of the host of this virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hypervisor:
{
Description: Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`. ,
Required: False ,
}
{
hypervisorType:
{
Description: Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
}
,
Required: False ,
}
enum ,
nativeHostMachineId:
{
Description: The unique identifier of the hypervisor machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hosting:
{
Description: Hosting-related configuration. Present if hosting information is discovered for the VM. ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_Get (removed)
Description :  Returns the specified machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate the machine resource. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this resource was updated in the system. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the machine is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
virtualizationState:
{
Description: Specifies whether the machine is virtualized. ,
Enum:
{
unknown: No description available. ,
physical: No description available. ,
virtual: No description available. ,
hypervisor: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
computerName:
{
Description: Name of the machine, e.g., server ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: Fully-qualified name of the machine, e.g., server.company.com ,
Required: False ,
}
string ,
bootTime:
{
Description: UTC date and time when the machine last booted ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: Timezone of the machine. ,
Required: False ,
}
{
fullName:
{
Description: Timezone full name. ,
Required: False ,
}
string ,
}
,
agent:
{
Description: Dependency Agent configuration. ,
Required: False ,
}
{
agentId:
{
Description: Health Service Agent unique identifier. ,
Required: True ,
}
string ,
dependencyAgentId:
{
Description: Dependency Agent unique identifier. ,
Required: False ,
}
string ,
dependencyAgentVersion:
{
Description: Dependency Agent version number. ,
Required: False ,
}
string ,
dependencyAgentRevision:
{
Description: Dependency Agent revision number. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: Specifies whether the machine has been rebooted since the Dependency Agent installation. ,
Enum:
{
unknown: No description available. ,
rebooted: No description available. ,
notRebooted: No description available. ,
}
,
Required: False ,
}
enum ,
clockGranularity:
{
Description: Machine clock granularity in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
resources:
{
Description: Machine resources (memory, cpu, etc.). ,
Required: False ,
}
{
physicalMemory:
{
Description: Physical memory in megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
cpus:
{
Description: Number of CPUs. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeed:
{
Description: CPU speed in megahertz (Mhz). ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeedAccuracy:
{
Description: Describes the accuracy of the cpuSpeed field. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networking:
{
Description: Network configuration (ips, gateways, dns, etc.) ,
Required: False ,
}
{
ipv4Interfaces:
{
Description: IPv4 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv4 address. ,
Required: True ,
}
string ,
subnetMask:
{
Description: IPv4 subnet mask. ,
Required: False ,
}
string ,
}
,
]
,
ipv6Interfaces:
{
Description: IPv6 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv6 address. ,
Required: True ,
}
string ,
}
,
]
,
defaultIpv4Gateways:
{
Description: Default IPv4 gateways. ,
Required: False ,
}
[
string ,
]
,
macAddresses:
{
Description: MAC addresses of all active network interfaces. ,
Required: False ,
}
[
string ,
]
,
dnsNames:
{
Description: DNS names associated with the machine. ,
Required: False ,
}
[
string ,
]
,
}
,
operatingSystem:
{
Description: Operating system information. ,
Required: False ,
}
{
family:
{
Description: Windows, Linux, etc. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: True ,
}
enum ,
fullName:
{
Description: Operating system full name. ,
Required: True ,
}
string ,
bitness:
{
Description: Operating system bitness (32-bit or 64-bit). ,
Enum:
{
32bit: No description available. ,
64bit: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
virtualMachine:
{
Description: Virtualization-related configuration. Present only when `virtualizationState` is `virtual`. ,
Required: False ,
}
{
virtualMachineType:
{
Description: Specifies the virtualization technology used by the machine (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
ldom: No description available. ,
lpar: No description available. ,
vmware: No description available. ,
virtualPc: No description available. ,
xen: No description available. ,
}
,
Required: False ,
}
enum ,
nativeMachineId:
{
Description: The unique identifier of the virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
virtualMachineName:
{
Description: The Name of the virtual machine. ,
Required: False ,
}
string ,
nativeHostMachineId:
{
Description: The unique identifier of the host of this virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hypervisor:
{
Description: Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`. ,
Required: False ,
}
{
hypervisorType:
{
Description: Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
}
,
Required: False ,
}
enum ,
nativeHostMachineId:
{
Description: The unique identifier of the hypervisor machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hosting:
{
Description: Hosting-related configuration. Present if hosting information is discovered for the VM. ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_GetLiveness (removed)
Description :  Obtains the liveness status of the machine during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/liveness
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Liveness interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Liveness interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
live:
{
Description: `true` if the resource is live during [startTime, endTime], `false` otherwise ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListConnections (removed)
Description :  Returns a collection of connections terminating or originating at the specified machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/connections
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListProcesses (removed)
Description :  Returns a collection of processes on the specified machine matching the specified conditions. The returned collection represents either processes that are active/live during the specified interval of time (`live=true` and `startTime`/`endTime` are specified) or that are known to have existed at or some time prior to the specified point in time (`live=false` and `timestamp` is specified).
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
live:
{
Description: Specifies whether to return live resources (true) or inventory resources (false). Defaults to **true**. When retrieving live resources, the start time (`startTime`) and end time (`endTime`) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (`timestamp`) parameter can be specified to return the version of each resource closest (not-after) that timestamp. ,
Required: False ,
}
boolean ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate all process resource. Only applies when `live=false`. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Process resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_Get (removed)
Description :  Returns the specified process.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
timestamp:
{
Description: UTC date and time specifying a time instance relative to which to evaluate a resource. When not specified, the service uses DateTime.UtcNow. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_GetLiveness (removed)
Description :  Obtains the liveness status of the process during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/liveness
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Liveness interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Liveness interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
live:
{
Description: `true` if the resource is live during [startTime, endTime], `false` otherwise ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_ListAcceptingPorts (removed)
Description :  Returns a collection of ports on which this process is accepting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/acceptingPorts
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Port resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Processes_ListConnections (removed)
Description :  Returns a collection of connections terminating or originating at the specified process
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/connections
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
processName:
{
Description: Process resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListPorts (removed)
Description :  Returns a collection of live ports on the specified machine during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Port resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_Get (removed)
Description :  Returns the specified port. The port must be live during the specified time interval. If the port is not live during the interval, status 404 (Not Found) is returned.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_GetLiveness (removed)
Description :  Obtains the liveness status of the port during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/liveness
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Liveness interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Liveness interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
live:
{
Description: `true` if the resource is live during [startTime, endTime], `false` otherwise ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_ListAcceptingProcesses (removed)
Description :  Returns a collection of processes accepting on the specified port
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/acceptingProcesses
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Process resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Ports_ListConnections (removed)
Description :  Returns a collection of connections established via the specified port.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/connections
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
portName:
{
Description: Port resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Machines_ListMachineGroupMembership (removed)
Description :  Returns a collection of machine groups this machine belongs to during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/machineGroups
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineName:
{
Description: Machine resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Machine Group resources. ,
Required: False ,
}
[
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
ClientGroups_Get (removed)
Description :  Retrieves the specified client group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Client Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
clientsOf:
{
Description: Reference to the resource whose clients are represented by this group. ,
Required: True ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
ClientGroups_GetMembersCount (removed)
Description :  Returns the approximate number of members in the client group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/membersCount
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Client Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
startTime:
{
Description: Membership interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Membership interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
groupId:
{
Description: Client Group URI. ,
Required: True ,
}
string ,
count:
{
Description: Number of members in the client group. Use this value together with the value of ```accuracy```. If accuracy is `exact` then the value represents the actual number of members in the cloud. When accuracy is `estimated`, the actual number of members is larger than the value of ```count```. ,
Format: int32 ,
Required: True ,
}
integer ,
accuracy:
{
Description: Accuracy of the reported count. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
ClientGroups_ListMembers (removed)
Description :  Returns the members of the client group during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/members
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
clientGroupName:
{
Description: Client Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
$top:
{
Description: Page size to use. When not specified, the default page size is 100 records. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Collection of ClientGroupMember resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
ipAddress:
{
Description: IP address. ,
Required: False ,
}
string ,
port:
{
Description: Port into which this client connected ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
processes:
{
Description: Processes accepting on the above port that received connections from this client. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the process. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Maps_Generate (removed)
Description :  Generates the specified map.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/generateMap
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
request:
{
Description: Request options. ,
Required: True ,
}
{
startTime:
{
Description: Map interval start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Map interval end time. ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: The type of map to create. ,
Enum:
{
map:single-machine-dependency: No description available. ,
map:machine-group-dependency: No description available. ,
map:machine-list-dependency: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
startTime:
{
Description: Map interval start time. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: Map interval end time. ,
Format: date-time ,
Required: True ,
}
string ,
map:
{
Description: The generated map. ,
Required: True ,
}
{
nodes:
{
Description: The nodes (entities) of a map. ,
Required: True ,
}
{
machines:
{
Description: Machine resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this resource was updated in the system. ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the machine is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
virtualizationState:
{
Description: Specifies whether the machine is virtualized. ,
Enum:
{
unknown: No description available. ,
physical: No description available. ,
virtual: No description available. ,
hypervisor: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
computerName:
{
Description: Name of the machine, e.g., server ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: Fully-qualified name of the machine, e.g., server.company.com ,
Required: False ,
}
string ,
bootTime:
{
Description: UTC date and time when the machine last booted ,
Format: date-time ,
Required: False ,
}
string ,
timezone:
{
Description: Timezone of the machine. ,
Required: False ,
}
{
fullName:
{
Description: Timezone full name. ,
Required: False ,
}
string ,
}
,
agent:
{
Description: Dependency Agent configuration. ,
Required: False ,
}
{
agentId:
{
Description: Health Service Agent unique identifier. ,
Required: True ,
}
string ,
dependencyAgentId:
{
Description: Dependency Agent unique identifier. ,
Required: False ,
}
string ,
dependencyAgentVersion:
{
Description: Dependency Agent version number. ,
Required: False ,
}
string ,
dependencyAgentRevision:
{
Description: Dependency Agent revision number. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: Specifies whether the machine has been rebooted since the Dependency Agent installation. ,
Enum:
{
unknown: No description available. ,
rebooted: No description available. ,
notRebooted: No description available. ,
}
,
Required: False ,
}
enum ,
clockGranularity:
{
Description: Machine clock granularity in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
resources:
{
Description: Machine resources (memory, cpu, etc.). ,
Required: False ,
}
{
physicalMemory:
{
Description: Physical memory in megabytes (MB). ,
Format: int32 ,
Required: False ,
}
integer ,
cpus:
{
Description: Number of CPUs. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeed:
{
Description: CPU speed in megahertz (Mhz). ,
Format: int32 ,
Required: False ,
}
integer ,
cpuSpeedAccuracy:
{
Description: Describes the accuracy of the cpuSpeed field. ,
Enum:
{
actual: No description available. ,
estimated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
networking:
{
Description: Network configuration (ips, gateways, dns, etc.) ,
Required: False ,
}
{
ipv4Interfaces:
{
Description: IPv4 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv4 address. ,
Required: True ,
}
string ,
subnetMask:
{
Description: IPv4 subnet mask. ,
Required: False ,
}
string ,
}
,
]
,
ipv6Interfaces:
{
Description: IPv6 interfaces. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IPv6 address. ,
Required: True ,
}
string ,
}
,
]
,
defaultIpv4Gateways:
{
Description: Default IPv4 gateways. ,
Required: False ,
}
[
string ,
]
,
macAddresses:
{
Description: MAC addresses of all active network interfaces. ,
Required: False ,
}
[
string ,
]
,
dnsNames:
{
Description: DNS names associated with the machine. ,
Required: False ,
}
[
string ,
]
,
}
,
operatingSystem:
{
Description: Operating system information. ,
Required: False ,
}
{
family:
{
Description: Windows, Linux, etc. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: True ,
}
enum ,
fullName:
{
Description: Operating system full name. ,
Required: True ,
}
string ,
bitness:
{
Description: Operating system bitness (32-bit or 64-bit). ,
Enum:
{
32bit: No description available. ,
64bit: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
virtualMachine:
{
Description: Virtualization-related configuration. Present only when `virtualizationState` is `virtual`. ,
Required: False ,
}
{
virtualMachineType:
{
Description: Specifies the virtualization technology used by the machine (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
ldom: No description available. ,
lpar: No description available. ,
vmware: No description available. ,
virtualPc: No description available. ,
xen: No description available. ,
}
,
Required: False ,
}
enum ,
nativeMachineId:
{
Description: The unique identifier of the virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
virtualMachineName:
{
Description: The Name of the virtual machine. ,
Required: False ,
}
string ,
nativeHostMachineId:
{
Description: The unique identifier of the host of this virtual machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hypervisor:
{
Description: Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`. ,
Required: False ,
}
{
hypervisorType:
{
Description: Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.) ,
Enum:
{
unknown: No description available. ,
hyperv: No description available. ,
}
,
Required: False ,
}
enum ,
nativeHostMachineId:
{
Description: The unique identifier of the hypervisor machine as reported by the underlying virtualization system. ,
Required: False ,
}
string ,
}
,
hosting:
{
Description: Hosting-related configuration. Present if hosting information is discovered for the VM. ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
processes:
{
Description: Process resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timestamp:
{
Description: UTC date and time when this process resource was updated in the system ,
Format: date-time ,
Required: False ,
}
string ,
monitoringState:
{
Description: Specifies whether the process is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this process. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
executableName:
{
Description: The name of the process executable ,
Required: False ,
}
string ,
displayName:
{
Description: Name to use for display purposes ,
Required: False ,
}
string ,
startTime:
{
Description: UTC date and time when the process started ,
Format: date-time ,
Required: False ,
}
string ,
role:
{
Description: The inferred role of this process based on its name, command line, etc. ,
Enum:
{
webServer: No description available. ,
appServer: No description available. ,
databaseServer: No description available. ,
ldapServer: No description available. ,
smbServer: No description available. ,
}
,
Required: False ,
}
enum ,
group:
{
Description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc. ,
Required: False ,
}
string ,
details:
{
Description: Process metadata (command line, product name, etc.). ,
Required: False ,
}
{
persistentKey:
{
Description: A unique identifier for a process, generally resilient to process restart, computed by Service Map. ,
Required: False ,
}
string ,
poolId:
{
Description: Represents the identity of the process pool assigned to the process by Dependency Agent. ,
Format: int32 ,
Required: False ,
}
integer ,
firstPid:
{
Description: The Operating System Process Identifier (PID) of the first process in this process pool. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Process description. ,
Required: False ,
}
string ,
companyName:
{
Description: Name of company that created the process executable. ,
Required: False ,
}
string ,
internalName:
{
Description: Internal process name. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
productVersion:
{
Description: Product version. ,
Required: False ,
}
string ,
fileVersion:
{
Description: File version. ,
Required: False ,
}
string ,
commandLine:
{
Description: Process command line. ,
Required: False ,
}
string ,
executablePath:
{
Description: Process executable path. ,
Required: False ,
}
string ,
workingDirectory:
{
Description: Process workingDirectory. ,
Required: False ,
}
string ,
services:
{
Description: Collection of services hosted by this Process (Windows only). ,
Required: False ,
}
[
{
name:
{
Description: The name of the service. ,
Required: False ,
}
string ,
displayName:
{
Description: The service's display name. ,
Required: False ,
}
string ,
}
,
]
,
zoneName:
{
Description: Process zone name (Linux only). ,
Required: False ,
}
string ,
}
,
user:
{
Description: Information about the account under which the process is executing. ,
Required: False ,
}
{
userName:
{
Description: User name under which the process is running. ,
Required: False ,
}
string ,
userDomain:
{
Description: Domain name for the user. ,
Required: False ,
}
string ,
}
,
clientOf:
{
Description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acceptorOf:
{
Description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
hosting:
{
Description: Information about the hosting environment ,
Required: False ,
}
{
provider:
{
Description: The hosting provider of the VM. ,
Enum:
{
azure: No description available. ,
}
,
Required: False ,
}
enum ,
kind:
{
Description: Additional hosting configuration type qualifier. ,
Enum:
{
provider:azure: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
ports:
{
Description: Port resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
monitoringState:
{
Description: Specifies whether the port is actively monitored or discovered. ,
Enum:
{
monitored: No description available. ,
discovered: No description available. ,
}
,
Required: False ,
}
enum ,
machine:
{
Description: Machine hosting this port. ,
Required: False ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Name to use for display purposes. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address associated with the port. At present only IPv4 addresses are supported. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
clientGroups:
{
Description: Client Group resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
clientsOf:
{
Description: Reference to the resource whose clients are represented by this group. ,
Required: True ,
}
{
id:
{
Description: Resource URI. ,
Required: True ,
}
string ,
type:
{
Description: Resource type qualifier. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
kind:
{
Description: Specifies the sub-class of the reference. ,
Enum:
{
ref:machine: No description available. ,
ref:machinewithhints: No description available. ,
ref:process: No description available. ,
ref:port: No description available. ,
ref:onmachine: No description available. ,
ref:clientgroup: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
}
,
edges:
{
Description: The edges (relationships) of a map. ,
Required: True ,
}
{
connections:
{
Description: Network connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a connection resource. ,
Required: False ,
}
{
serverPort:
{
Description: Reference to the server port via which this connection has been established. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
failureState:
{
Description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. ,
Enum:
{
ok: No description available. ,
failed: No description available. ,
mixed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
acceptors:
{
Description: Processes accepting on a port. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for an acceptor relationship. ,
Required: False ,
}
{
source:
{
Description: Port being accepted. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the port. ,
Required: False ,
}
string ,
ipAddress:
{
Description: IP address of the port. ,
Required: False ,
}
string ,
portNumber:
{
Description: Port number. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
destination:
{
Description: Accepting process. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
machine:
{
Description: Machine hosting the process. ,
Required: False ,
}
string ,
}
,
}
,
startTime:
{
Description: Relationship start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Relationship end time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
Summaries_GetMachines (removed)
Description :  Returns summary information about the machines in the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/summaries/machines
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Summarizes machines in the workspace. ,
Required: False ,
}
{
total:
{
Description: Total number of machines. ,
Format: int32 ,
Required: True ,
}
integer ,
live:
{
Description: Number of live machines. ,
Format: int32 ,
Required: True ,
}
integer ,
os:
{
Description: Machine counts by operating system. ,
Required: True ,
}
{
windows:
{
Description: Number of live Windows machines. ,
Format: int32 ,
Required: True ,
}
integer ,
linux:
{
Description: Number of live Linux machines. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_ListByWorkspace (removed)
Description :  Returns all machine groups during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Machine Group resources. ,
Required: False ,
}
[
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Create (removed)
Description :  Creates a new machine group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroup:
{
Description: Machine Group resource to create. ,
Required: True ,
}
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Get (removed)
Description :  Returns the specified machine group as it existed during the specified time interval.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroupName:
{
Description: Machine Group resource name. ,
Required: True ,
}
string ,
startTime:
{
Description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Update (removed)
Description :  Updates a machine group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroupName:
{
Description: Machine Group resource name. ,
Required: True ,
}
string ,
machineGroup:
{
Description: Machine Group resource to update. ,
Required: True ,
}
{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: Resource ETAG. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the machine group ,
Enum:
{
unknown: No description available. ,
azure-cs: No description available. ,
azure-sf: No description available. ,
azure-vmss: No description available. ,
user-static: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: User defined name for the group ,
Required: True ,
}
string ,
count:
{
Description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle. ,
Format: int32 ,
Required: False ,
}
integer ,
machines:
{
Description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated. ,
Required: False ,
}
[
{
properties:
{
Description: Machine reference with name and os hints. ,
Required: False ,
}
{
displayNameHint:
{
Description: Last known display name. ,
Required: False ,
}
string ,
osFamilyHint:
{
Description: Last known operating system family. ,
Enum:
{
unknown: No description available. ,
windows: No description available. ,
linux: No description available. ,
solaris: No description available. ,
aix: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}
MachineGroups_Delete (removed)
Description :  Deletes the specified Machine Group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
{
subscriptionId:
{
Description: Azure subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name within the specified subscriptionId. ,
Required: True ,
}
string ,
workspaceName:
{
Description: OMS workspace containing the resources of interest. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
machineGroupName:
{
Description: Machine Group resource name. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error information. ,
Required: True ,
}
{
code:
{
Description: Error code identifying the specific error. ,
Required: True ,
}
string ,
message:
{
Description: Error message in the caller's locale. ,
Required: False ,
}
string ,
}
,
}