Ports - Get Liveness

Obtains the liveness status of the port during the specified time interval.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Azure subscription identifier.

resourceGroupName
path True
  • string

Resource group name within the specified subscriptionId.

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

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_]

machineName
path True
  • string

Machine resource name.

portName
path True
  • string

Port resource name.

api-version
query True
  • string

API version.

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

endTime
query
  • string
date-time

UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow

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

SMMachinesPortsGetLivenessGet

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-999066c5-38c5-4f2f-9ce0-51d738cdc432/ports/b-c0a80101_8000/liveness?api-version=2015-11-01-preview&startTime=2018-01-07T08:01:48.525Z&endTime=2018-01-07T08:01:48.525Z

Sample Response

{
  "startTime": "2018-01-07T08:01:48.525Z",
  "endTime": "2018-01-07T08:01:48.525Z",
  "live": true
}

Definitions

Error

Error details.

ErrorResponse

An error response from the API.

Liveness

Specifies the contents of a check liveness response.

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.

Liveness

Specifies the contents of a check liveness response.

Name Type Description
endTime
  • string

Liveness interval end time.

live
  • boolean

true if the resource is live during [startTime, endTime], false otherwise

startTime
  • string

Liveness interval start time.