Ports - List Connections
Returns a collection of connections established via the specified port.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/connections?api-version=2015-11-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/connections?api-version=2015-11-01-preview&startTime={startTime}&endTime={endTime}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
machine
|
path | True |
string |
Machine resource name. |
port
|
path | True |
string |
Port resource name. |
resource
|
path | True |
string |
Resource group name within the specified subscriptionId. Regex pattern: |
subscription
|
path | True |
string |
Azure subscription identifier. |
workspace
|
path | True |
string |
OMS workspace containing the resources of interest. Regex pattern: |
api-version
|
query | True |
string |
API version. |
end
|
query |
string date-time |
UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow |
|
start
|
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 |
The operation completed successfully. |
|
Other Status Codes |
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
SMMachinesPortsListConnectionsGet
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/ports/b-c0a8010a_10000/connections?api-version=2015-11-01-preview&startTime=2018-01-08T23:05:16.7985488Z&endTime=2018-01-08T23:07:16.7985488Z
Sample Response
{
"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-9b60b5e7-fb98-4864-9a1f-51d26407f99b",
"type": "Microsoft.OperationalInsights/workspaces/features/machines",
"name": "m-9b60b5e7-fb98-4864-9a1f-51d26407f99b"
}
},
"id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-9b60b5e7-fb98-4864-9a1f-51d26407f99b/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-f1dd514e73cda65d9a19a977aa4a9f6959427ab0",
"type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
"name": "p-f1dd514e73cda65d9a19a977aa4a9f6959427ab0"
},
"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": "192.168.1.10",
"portNumber": 10000
},
"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-c0a8010a_10000",
"type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
"name": "b-c0a8010a_10000"
},
"failureState": "ok"
},
"id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/connections/m@m-9b60b5e7-fb98-4864-9a1f-51d26407f99b@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-f1dd514e73cda65d9a19a977aa4a9f6959427ab0!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-c0a8010a_10000",
"type": "Microsoft.OperationalInsights/workspaces/features/connections",
"name": "m@m-9b60b5e7-fb98-4864-9a1f-51d26407f99b@p@p-d642fef420c5baa4c72f53de9426f1ed699899e2!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-f1dd514e73cda65d9a19a977aa4a9f6959427ab0!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-c0a8010a_10000"
},
{
"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-c0a8010a_10000",
"type": "Microsoft.OperationalInsights/workspaces/features/clientGroups",
"name": "m!m-A4AB1C69-03E9-42D2-B822-B42555569FB4!b!b-c0a8010a_10000"
},
"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-f1dd514e73cda65d9a19a977aa4a9f6959427ab0",
"type": "Microsoft.OperationalInsights/workspaces/features/machines/processes",
"name": "p-f1dd514e73cda65d9a19a977aa4a9f6959427ab0"
},
"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": "192.168.1.10",
"portNumber": 10000
},
"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-c0a8010a_10000",
"type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
"name": "b-c0a8010a_10000"
},
"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-c0a8010a_10000!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-f1dd514e73cda65d9a19a977aa4a9f6959427ab0!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-c0a8010a_10000",
"type": "Microsoft.OperationalInsights/workspaces/features/connections",
"name": "c@m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-c0a8010a_10000!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@p@p-f1dd514e73cda65d9a19a977aa4a9f6959427ab0!m@m-A4AB1C69-03E9-42D2-B822-B42555569FB4@b@b-c0a8010a_10000"
}
]
}
Definitions
Name | Description |
---|---|
Client |
Reference to a client group. |
Connection |
A network connection. |
Connection |
Collection of Connection resources. |
Connection |
Connection failure state:
|
Error |
Error details. |
Error |
An error response from the API. |
Machine |
Reference to a machine. |
Machine |
A machine reference with a hint of the machine's name and operating system. |
Operating |
Specifies the operating system family, e.g., Linux, Windows, etc. |
Port |
Reference to a port. |
Process |
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 |
Specifies whether there are only successful, failed or a mixture of both connections represented by this resource. |
|
properties.serverPort |
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 |
Collection of Connection resources. |
ConnectionFailureState
Connection failure state:
ok
indicates no failuresfailed
indicates only failuresmixed
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 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 |
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 |
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 |
Machine hosting the process. |
|
type |
string |
Resource type qualifier. |