Ports - List Accepting Processes

Reference

Service:: Service Map

API Version:: 2015-11-01-preview

Returns a collection of processes accepting on the specified port

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
machineName	path	True	string	Machine resource name.
portName	path	True	string	Port resource name.
resourceGroupName	path	True	string	Resource group name within the specified subscriptionId. Regex pattern: `[a-zA-Z0-9_-]+`
subscriptionId	path	True	string	Azure subscription identifier.
workspaceName	path	True	string	OMS workspace containing the resources of interest. Regex pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]+[a-zA-Z0-9_]`
api-version	query	True	string	API version.
endTime	query		string date-time	UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
startTime	query		string date-time	UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m

Responses

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

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

SMMachinesPortsListAcceptingProcessesGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/features/serviceMap/machines/m-1bc28d72-0e81-4aff-b1e3-ae12e8da155e/ports/b-c0a80101_8000/acceptingProcesses?api-version=2015-11-01-preview&startTime=2018-01-08T18:37:39.936Z&endTime=2018-01-08T18:37:54.936Z

Sample Response

Status code:: 200

{
  "value": [
    {
      "kind": "process",
      "properties": {
        "monitoringState": "monitored",
        "machine": {
          "kind": "ref:machine",
          "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-1bc28d72-0e81-4aff-b1e3-ae12e8da155e",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines",
          "name": "m-1bc28d72-0e81-4aff-b1e3-ae12e8da155e"
        },
        "executableName": "process",
        "displayName": "process",
        "startTime": "2018-01-08T18:27:39.936Z",
        "group": "myproductname",
        "details": {
          "persistentKey": "1a502634-e7ca-4c56-b10d-545f60623ef2",
          "poolId": 12,
          "firstPid": 10,
          "description": "mydescription",
          "companyName": "mycompany",
          "internalName": "myinternalname",
          "productName": "myproductname",
          "productVersion": "3.3.3.3",
          "fileVersion": "1.2.3.4",
          "commandLine": "cmdline",
          "executablePath": "mypath",
          "workingDirectory": "myworkingdir",
          "services": [
            {
              "name": "foosvc",
              "displayName": "Foo Service"
            }
          ],
          "zoneName": "LinuxOnlyZone"
        },
        "user": {
          "userName": "myuser",
          "userDomain": "mydomain"
        }
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-1bc28d72-0e81-4aff-b1e3-ae12e8da155e/processes/p-e832fd7598b913c9f6d751b977028248c48c35dc",
      "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
      "name": "p-e832fd7598b913c9f6d751b977028248c48c35dc"
    },
    {
      "kind": "process",
      "properties": {
        "monitoringState": "monitored",
        "machine": {
          "kind": "ref:machine",
          "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-1bc28d72-0e81-4aff-b1e3-ae12e8da155e",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines",
          "name": "m-1bc28d72-0e81-4aff-b1e3-ae12e8da155e"
        },
        "executableName": "process",
        "displayName": "process",
        "startTime": "2018-01-08T18:27:39.936Z",
        "group": "myproductname",
        "details": {
          "persistentKey": "677cde70-5589-41f3-89b8-4b866ed5c86e",
          "poolId": 12,
          "firstPid": 10,
          "description": "mydescription",
          "companyName": "mycompany",
          "internalName": "myinternalname",
          "productName": "myproductname",
          "productVersion": "3.3.3.3",
          "fileVersion": "1.2.3.4",
          "commandLine": "cmdline",
          "executablePath": "mypath",
          "workingDirectory": "myworkingdir",
          "services": [
            {
              "name": "foosvc",
              "displayName": "Foo Service"
            }
          ],
          "zoneName": "LinuxOnlyZone"
        },
        "user": {
          "userName": "myuser",
          "userDomain": "mydomain"
        }
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-1bc28d72-0e81-4aff-b1e3-ae12e8da155e/processes/p-fa195e268682d998e42071ff3346c09f0af4f9e8",
      "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
      "name": "p-fa195e268682d998e42071ff3346c09f0af4f9e8"
    }
  ]
}

Definitions

Name	Description
AzureCloudServiceConfiguration	Describes an Azure Cloud Service
AzureCloudServiceRoleType	Used to specify type of an Azure Cloud Service role
AzureProcessHostingConfiguration	Describes the hosting configuration of a process when hosted on azure
ClientGroupReference	Reference to a client group.
Error	Error details.
ErrorResponse	An error response from the API.
MachineReference	Reference to a machine.
MachineReferenceWithHints	A machine reference with a hint of the machine's name and operating system.
MonitoringState	Used to specify if a resources is monitored or discovered.
OperatingSystemFamily	Specifies the operating system family, e.g., Linux, Windows, etc.
PortReference	Reference to a port.
Process	A process resource represents a process running on a machine. The process may be actively monitored, i.e., a Dependency Agent is running on its machine, or discovered, i.e., its existence was inferred by observing the data stream from monitored machines. A process resource represents a pool of actual operating system resources that share command lines and metadata. As the process pool evolves over time, prior versions of the process resource are preserved and available for access. A process is live during an interval of time, if that process is executing during (parts) of that interval
ProcessCollection	Collection of Process resources.
ProcessDetails	Describes process metadata.
ProcessHostedService	A service hosted by a process.
ProcessReference	Reference to a process.
ProcessRole	The inferred role of this process based on its name, command line, etc.
ProcessUser	Describes the user under which a process is running.

AzureCloudServiceConfiguration

Describes an Azure Cloud Service

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

AzureCloudServiceRoleType

Used to specify type of an Azure Cloud Service role

Name	Type	Description
unknown	string
web	string
worker	string

AzureProcessHostingConfiguration

Describes the hosting configuration of a process when hosted on azure

Name	Type	Description
cloudService	AzureCloudServiceConfiguration	Contains information about the cloud service the process belongs to
kind	string: provider:azure	Additional hosting configuration type qualifier.
provider	enum: azure	The hosting provider of the VM.

ClientGroupReference

Reference to a client group.

Name	Type	Description
id	string	Resource URI.
kind	string: ref:clientgroup	Specifies the sub-class of the reference.
name	string	Resource name.
type	string	Resource type qualifier.

Error

Error details.

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

ErrorResponse

An error response from the API.

Name	Type	Description
error	Error	Error information.

MachineReference

Reference to a machine.

Name	Type	Description
id	string	Resource URI.
kind	string: ref:machine	Specifies the sub-class of the reference.
name	string	Resource name.
type	string	Resource type qualifier.

MachineReferenceWithHints

A machine reference with a hint of the machine's name and operating system.

Name	Type	Description
id	string	Resource URI.
kind	string: ref:machinewithhints	Specifies the sub-class of the reference.
name	string	Resource name.
properties.displayNameHint	string	Last known display name.
properties.osFamilyHint	OperatingSystemFamily	Last known operating system family.
type	string	Resource type qualifier.

MonitoringState

Used to specify if a resources is monitored or discovered.

Name	Type	Description
discovered	string
monitored	string

OperatingSystemFamily

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

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

PortReference

Reference to a port.

Name	Type	Description
id	string	Resource URI.
kind	string: ref:port	Specifies the sub-class of the reference.
name	string	Resource name.
properties.ipAddress	string	IP address of the port.
properties.machine	MachineReference	Machine hosting the port.
properties.portNumber	integer	Port number.
type	string	Resource type qualifier.

Process

A process resource represents a process running on a machine. The process may be actively monitored, i.e., a Dependency Agent is running on its machine, or discovered, i.e., its existence was inferred by observing the data stream from monitored machines. A process resource represents a pool of actual operating system resources that share command lines and metadata. As the process pool evolves over time, prior versions of the process resource are preserved and available for access. A process is live during an interval of time, if that process is executing during (parts) of that interval

Name	Type	Description
etag	string	Resource ETAG.
id	string	Resource identifier.
kind	string: process	Additional resource type qualifier.
name	string	Resource name.
properties.acceptorOf	ResourceReference: ClientGroupReference MachineReference MachineReferenceWithHints PortReference ProcessReference	Present only for a discovered process acting as a server. References the port on which the discovered process is accepting.
properties.clientOf	ResourceReference: ClientGroupReference MachineReference MachineReferenceWithHints PortReference ProcessReference	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.
properties.details	ProcessDetails	Process metadata (command line, product name, etc.).
properties.displayName	string	Name to use for display purposes
properties.executableName	string	The name of the process executable
properties.group	string	The name of the product or suite of the process. The group is determined by its executable name, command line, etc.
properties.hosting	ProcessHostingConfiguration: AzureProcessHostingConfiguration	Information about the hosting environment
properties.machine	ResourceReference: ClientGroupReference MachineReference MachineReferenceWithHints PortReference ProcessReference	Machine hosting this process.
properties.monitoringState	MonitoringState	Specifies whether the process is actively monitored or discovered.
properties.role	ProcessRole	The inferred role of this process based on its name, command line, etc.
properties.startTime	string	UTC date and time when the process started
properties.timestamp	string	UTC date and time when this process resource was updated in the system
properties.user	ProcessUser	Information about the account under which the process is executing.
type	string	Resource type.

ProcessCollection

Collection of Process resources.

Name	Type	Description
nextLink	string	The URL to the next set of resources.
value	Process[]	Collection of Process resources.

ProcessDetails

Describes process metadata.

Name	Type	Description
commandLine	string	Process command line.
companyName	string	Name of company that created the process executable.
description	string	Process description.
executablePath	string	Process executable path.
fileVersion	string	File version.
firstPid	integer	The Operating System Process Identifier (PID) of the first process in this process pool.
internalName	string	Internal process name.
persistentKey	string	A unique identifier for a process, generally resilient to process restart, computed by Service Map.
poolId	integer	Represents the identity of the process pool assigned to the process by Dependency Agent.
productName	string	Product name.
productVersion	string	Product version.
services	ProcessHostedService[]	Collection of services hosted by this Process (Windows only).
workingDirectory	string	Process workingDirectory.
zoneName	string	Process zone name (Linux only).

ProcessHostedService

A service hosted by a process.

Name	Type	Description
displayName	string	The service's display name.
name	string	The name of the service.

ProcessReference

Reference to a process.

Name	Type	Description
id	string	Resource URI.
kind	string: ref:process	Specifies the sub-class of the reference.
name	string	Resource name.
properties.machine	MachineReference	Machine hosting the process.
type	string	Resource type qualifier.

ProcessRole

The inferred role of this process based on its name, command line, etc.

Name	Type	Description
appServer	string
databaseServer	string
ldapServer	string
smbServer	string
webServer	string

ProcessUser

Describes the user under which a process is running.

Name	Type	Description
userDomain	string	Domain name for the user.
userName	string	User name under which the process is running.