Summaries - Get Machines

Reference

Service:: Service Map

API Version:: 2015-11-01-preview

Returns summary information about the machines in the workspace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/summaries/machines?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/summaries/machines?api-version=2015-11-01-preview&startTime={startTime}&endTime={endTime}

URI Parameters

Name	In	Required	Type	Description
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	MachinesSummary	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

SMSummariesGetMachinesGet

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/summaries/machines?api-version=2015-11-01-preview&startTime=2018-01-08T19:41:59.3360000Z&endTime=2018-01-08T19:42:14.3360000Z

Sample Response

Status code:: 200

{
  "properties": {
    "startTime": "2018-01-08T19:41:59.336Z",
    "endTime": "2018-01-08T19:42:14.336Z",
    "total": 3,
    "live": 3,
    "os": {
      "windows": 2,
      "linux": 1
    }
  },
  "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/features/serviceMap/summaries/machines",
  "type": "Microsoft.OperationalInsights/workspaces/features/summaries",
  "name": "machines"
}

Definitions

Name	Description
Error	Error details.
ErrorResponse	An error response from the API.
MachineCountsByOperatingSystem	Machines by operating system.
MachinesSummary	A summary of the machines in the workspace.

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.

MachineCountsByOperatingSystem

Machines by operating system.

Name	Type	Description
linux	integer	Number of live Linux machines.
windows	integer	Number of live Windows machines.

MachinesSummary

A summary of the machines in the workspace.

Name	Type	Description
id	string	Resource identifier.
name	string	Resource name.
properties.endTime	string	Summary interval end time.
properties.live	integer	Number of live machines.
properties.os	MachineCountsByOperatingSystem	Machine counts by operating system.
properties.startTime	string	Summary interval start time.
properties.total	integer	Total number of machines.
type	string	Resource type.