Share via

Ports interface

  • Reference
Package:
@azure/arm-servicemap

Interface representing a Ports.

Methods

get(string, string, string, string, PortsGetOptionalParams)

Returns the specified port. The port must be live during the specified time interval. If the port is not live during the interval, status 404 (Not Found) is returned.
getLiveness(string, string, string, string, PortsGetLivenessOptionalParams)

Obtains the liveness status of the port during the specified time interval.
listAcceptingProcesses(string, string, string, string, PortsListAcceptingProcessesOptionalParams)

Returns a collection of processes accepting on the specified port
listConnections(string, string, string, string, PortsListConnectionsOptionalParams)

Returns a collection of connections established via the specified port.

Method Details

get(string, string, string, string, PortsGetOptionalParams)

Returns the specified port. The port must be live during the specified time interval. If the port is not live during the interval, status 404 (Not Found) is returned.

function get(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: PortsGetOptionalParams): Promise<Port>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineName

string

Machine resource name.

portName

string

Port resource name.

options
PortsGetOptionalParams

The options parameters.

Returns

Promise<Port>

getLiveness(string, string, string, string, PortsGetLivenessOptionalParams)

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

function getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: PortsGetLivenessOptionalParams): Promise<Liveness>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineName

string

Machine resource name.

portName

string

Port resource name.

options
PortsGetLivenessOptionalParams

The options parameters.

Returns

Promise<Liveness>

listAcceptingProcesses(string, string, string, string, PortsListAcceptingProcessesOptionalParams)

Returns a collection of processes accepting on the specified port

function listAcceptingProcesses(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: PortsListAcceptingProcessesOptionalParams): PagedAsyncIterableIterator<Process, Process[], PageSettings>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineName

string

Machine resource name.

portName

string

Port resource name.

options
PortsListAcceptingProcessesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Process, Process[], PageSettings>

listConnections(string, string, string, string, PortsListConnectionsOptionalParams)

Returns a collection of connections established via the specified port.

function listConnections(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: PortsListConnectionsOptionalParams): PagedAsyncIterableIterator<Connection, Connection[], PageSettings>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineName

string

Machine resource name.

portName

string

Port resource name.

options
PortsListConnectionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Connection, Connection[], PageSettings>