Machine Groups - Get

Reference

Service:: Service Map

API Version:: 2015-11-01-preview

Returns the specified machine group as it existed during the specified time interval.

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

URI Parameters

Name	In	Required	Type	Description
machineGroupName	path	True	string	Machine Group 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	MachineGroup	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

SMMachineGroupsGetGet

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/machineGroups/07597c56-5395-4815-839c-c4e7bddbac18?api-version=2015-11-01-preview

Sample Response

Status code:: 200

{
  "kind": "machineGroup",
  "properties": {
    "groupType": "unknown",
    "displayName": "Foo",
    "count": 2,
    "machines": [
      {
        "kind": "ref:machinewithhints",
        "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-A4AB1C69-03E9-42D2-B822-B42555569FB4",
        "type": "Microsoft.OperationalInsights/workspaces/features/machines",
        "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
      },
      {
        "kind": "ref:machinewithhints",
        "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B",
        "type": "Microsoft.OperationalInsights/workspaces/features/machines",
        "name": "m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B"
      }
    ]
  },
  "etag": "6e87df32-c683-492d-bd2a-6dcd69c3034f",
  "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machineGroups/07597c56-5395-4815-839c-c4e7bddbac18",
  "type": "Microsoft.OperationalInsights/workspaces/features/machineGroups",
  "name": "07597c56-5395-4815-839c-c4e7bddbac18"
}

Definitions

Name	Description
Error	Error details.
ErrorResponse	An error response from the API.
MachineGroup	A user-defined logical grouping of machines.
MachineGroupType	Type of the machine group
MachineReferenceWithHints	A machine reference with a hint of the machine's name and operating system.
OperatingSystemFamily	Specifies the operating system family, e.g., Linux, Windows, etc.

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.

MachineGroup

A user-defined logical grouping of machines.

Name	Type	Description
etag	string	Resource ETAG.
id	string	Resource identifier.
kind	string: machineGroup	Additional resource type qualifier.
name	string	Resource name.
properties.count	integer	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.
properties.displayName	string	User defined name for the group
properties.groupType	MachineGroupType	Type of the machine group
properties.machines	MachineReferenceWithHints[]	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.
type	string	Resource type.

MachineGroupType

Type of the machine group

Name	Type	Description
azure-cs	string
azure-sf	string
azure-vmss	string
unknown	string
user-static	string

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.

OperatingSystemFamily

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

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