Machines - List Connections

  • Reference
Service:
Service Map
API Version:
2015-11-01-preview

Returns a collection of connections terminating or originating at the specified machine

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

URI Parameters

Name In Required Type Description
machineName
 path True

string

Machine resource name.
resourceGroupName
 path True

string

Resource group name within the specified subscriptionId.

Regex pattern: [a-zA-Z0-9_-]+
subscriptionId
 path True

string

Azure subscription identifier.
workspaceName
 path True

string

OMS workspace containing the resources of interest.

Regex pattern: [a-zA-Z0-9_][a-zA-Z0-9_-]+[a-zA-Z0-9_]
api-version
 query True

string

API version.
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

ConnectionCollection

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

SMMachinesListConnectionsGet

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "kind": "rel:connection",
      "properties": {
        "source": {
          "kind": "ref:process",
          "properties": {
            "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-00377B1B-7F4D-4EF8-8E1B-5B683DA02123",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-00377B1B-7F4D-4EF8-8E1B-5B683DA02123"
            }
          },
          "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-00377B1B-7F4D-4EF8-8E1B-5B683DA02123/processes/p-1a9dc431ad6048d83dade29fb72dfd9fbe2ee2b4",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-1a9dc431ad6048d83dade29fb72dfd9fbe2ee2b4"
        },
        "destination": {
          "kind": "ref:process",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            }
          },
          "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/processes/p-f107e3f1cb5d792e6abfed7832ba4e864f995cee",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-f107e3f1cb5d792e6abfed7832ba4e864f995cee"
        },
        "serverPort": {
          "kind": "ref:port",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            },
            "ipAddress": "1.0.0.1",
            "portNumber": 9000
          },
          "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/ports/b-01000001_9000",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
          "name": "b-01000001_9000"
        },
        "failureState": "ok"
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/connections/m@m-00377B1B-7F4D-4EF8-8E1B-5B683DA02123@p@p-1a9dc431ad6048d83dade29fb72dfd9fbe2ee2b4!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-f107e3f1cb5d792e6abfed7832ba4e864f995cee!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_9000",
      "type": "Microsoft.OperationalInsights/workspaces/features/connections",
      "name": "m@m-00377B1B-7F4D-4EF8-8E1B-5B683DA02123@p@p-1a9dc431ad6048d83dade29fb72dfd9fbe2ee2b4!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-f107e3f1cb5d792e6abfed7832ba4e864f995cee!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_9000"
    },
    {
      "kind": "rel:connection",
      "properties": {
        "source": {
          "kind": "ref:clientgroup",
          "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/clientGroups/m!m-A4AB1C69-03E9-42D2-B822-B42555569FB4!b!b-01000001_8000",
          "type": "Microsoft.OperationalInsights/workspaces/features/clientGroups",
          "name": "m!m-A4AB1C69-03E9-42D2-B822-B42555569FB4!b!b-01000001_8000"
        },
        "destination": {
          "kind": "ref:process",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            }
          },
          "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/processes/p-68cf5e3251379179122fa88e761e2acd5577c249",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-68cf5e3251379179122fa88e761e2acd5577c249"
        },
        "serverPort": {
          "kind": "ref:port",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            },
            "ipAddress": "1.0.0.1",
            "portNumber": 8000
          },
          "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/ports/b-01000001_8000",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
          "name": "b-01000001_8000"
        },
        "failureState": "ok"
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/connections/c@m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_8000!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-68cf5e3251379179122fa88e761e2acd5577c249!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_8000",
      "type": "Microsoft.OperationalInsights/workspaces/features/connections",
      "name": "c@m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_8000!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-68cf5e3251379179122fa88e761e2acd5577c249!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_8000"
    },
    {
      "kind": "rel:connection",
      "properties": {
        "source": {
          "kind": "ref:process",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            }
          },
          "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/processes/p-d642fef420c5baa4c72f53de9426f1ed699899e2",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-d642fef420c5baa4c72f53de9426f1ed699899e2"
        },
        "destination": {
          "kind": "ref:process",
          "properties": {
            "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-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B"
            }
          },
          "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/processes/p-08445135a7215e343f0f49b8d0b70c3b853ef87f",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-08445135a7215e343f0f49b8d0b70c3b853ef87f"
        },
        "serverPort": {
          "kind": "ref:port",
          "properties": {
            "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-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B"
            },
            "ipAddress": "2.0.0.1",
            "portNumber": 1001
          },
          "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/ports/b-02000001_1001",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
          "name": "b-02000001_1001"
        },
        "failureState": "ok"
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/connections/m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B@p@p-08445135a7215e343f0f49b8d0b70c3b853ef87f!m@m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B@b@b-02000001_1001",
      "type": "Microsoft.OperationalInsights/workspaces/features/connections",
      "name": "m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B@p@p-08445135a7215e343f0f49b8d0b70c3b853ef87f!m@m-21E1AC11-8AFF-4D2D-8A1F-72FEDA473F7B@b@b-02000001_1001"
    },
    {
      "kind": "rel:connection",
      "properties": {
        "source": {
          "kind": "ref:process",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            }
          },
          "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/processes/p-d642fef420c5baa4c72f53de9426f1ed699899e2",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-d642fef420c5baa4c72f53de9426f1ed699899e2"
        },
        "destination": {
          "kind": "ref:process",
          "properties": {
            "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-573847EE-4D31-4936-A8B2-771372806C80",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-573847EE-4D31-4936-A8B2-771372806C80"
            }
          },
          "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-573847EE-4D31-4936-A8B2-771372806C80/processes/p-daedaa0e25869b6cf36525d51c2d321335e69f71",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-daedaa0e25869b6cf36525d51c2d321335e69f71"
        },
        "serverPort": {
          "kind": "ref:port",
          "properties": {
            "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-573847EE-4D31-4936-A8B2-771372806C80",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-573847EE-4D31-4936-A8B2-771372806C80"
            },
            "ipAddress": "2.0.0.2",
            "portNumber": 1002
          },
          "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-573847EE-4D31-4936-A8B2-771372806C80/ports/b-02000002_1002",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
          "name": "b-02000002_1002"
        },
        "failureState": "ok"
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/connections/m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-573847EE-4D31-4936-A8B2-771372806C80@p@p-daedaa0e25869b6cf36525d51c2d321335e69f71!m@m-573847EE-4D31-4936-A8B2-771372806C80@b@b-02000002_1002",
      "type": "Microsoft.OperationalInsights/workspaces/features/connections",
      "name": "m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-573847EE-4D31-4936-A8B2-771372806C80@p@p-daedaa0e25869b6cf36525d51c2d321335e69f71!m@m-573847EE-4D31-4936-A8B2-771372806C80@b@b-02000002_1002"
    },
    {
      "kind": "rel:connection",
      "properties": {
        "source": {
          "kind": "ref:process",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            }
          },
          "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/processes/p-d642fef420c5baa4c72f53de9426f1ed699899e2",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-d642fef420c5baa4c72f53de9426f1ed699899e2"
        },
        "destination": {
          "kind": "ref:process",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            }
          },
          "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/processes/p-68cf5e3251379179122fa88e761e2acd5577c249",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
          "name": "p-68cf5e3251379179122fa88e761e2acd5577c249"
        },
        "serverPort": {
          "kind": "ref:port",
          "properties": {
            "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-A4AB1C69-03E9-42D2-B822-B42555569FB4",
              "type": "Microsoft.OperationalInsights/workspaces/features/machines",
              "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
            },
            "ipAddress": "1.0.0.1",
            "portNumber": 8000
          },
          "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/ports/b-01000001_8000",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
          "name": "b-01000001_8000"
        },
        "failureState": "ok"
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/connections/m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-68cf5e3251379179122fa88e761e2acd5577c249!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_8000",
      "type": "Microsoft.OperationalInsights/workspaces/features/connections",
      "name": "m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-68cf5e3251379179122fa88e761e2acd5577c249!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-01000001_8000"
    }
  ]
}

Definitions

Name Description
ClientGroupReference

Reference to a client group.
Connection

A network connection.
ConnectionCollection

Collection of Connection resources.
ConnectionFailureState

Connection failure state:

  • ok indicates no failures
  • failed indicates only failures
  • mixed indicates both failures and successes
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.
OperatingSystemFamily

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

Reference to a port.
ProcessReference

Reference to a process.

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.

Connection

A network connection.

Name Type Description
id

string

Resource identifier.
kind string:

rel:connection

Additional resource type qualifier.
name

string

Resource name.
properties.destination ResourceReference:

Destination resource of the relationship.
properties.endTime

string

Relationship end time.
properties.failureState

ConnectionFailureState

Specifies whether there are only successful, failed or a mixture of both connections represented by this resource.
properties.serverPort

PortReference

Reference to the server port via which this connection has been established.
properties.source ResourceReference:

Source resource of the relationship.
properties.startTime

string

Relationship start time.
type

string

Resource type.

ConnectionCollection

Collection of Connection resources.

Name Type Description
nextLink

string

The URL to the next set of resources.
value

Connection[]

Collection of Connection resources.

ConnectionFailureState

Connection failure state:

  • ok indicates no failures
  • failed indicates only failures
  • mixed indicates both failures and successes
Name Type Description
failed

string

mixed

string

ok

string

Error

Error details.

Name Type Description
code

string

Error code identifying the specific error.
message

string

Error message in the caller's locale.

ErrorResponse

An error response from the API.

Name Type Description
error

Error

Error information.

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.

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.

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.