Ports class

Class representing a Ports.

Constructors

Ports(ServicemapManagementClientContext)

Create 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.

get(string, string, string, string, PortsGetOptionalParams, ServiceCallback<Port>)
get(string, string, string, string, ServiceCallback<Port>)
getLiveness(string, string, string, string, PortsGetLivenessOptionalParams)

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

getLiveness(string, string, string, string, PortsGetLivenessOptionalParams, ServiceCallback<Liveness>)
getLiveness(string, string, string, string, ServiceCallback<Liveness>)
listAcceptingProcesses(string, string, string, string, PortsListAcceptingProcessesOptionalParams)

Returns a collection of processes accepting on the specified port

listAcceptingProcesses(string, string, string, string, PortsListAcceptingProcessesOptionalParams, ServiceCallback<ProcessCollection>)
listAcceptingProcesses(string, string, string, string, ServiceCallback<ProcessCollection>)
listAcceptingProcessesNext(string, RequestOptionsBase)

Returns a collection of processes accepting on the specified port

listAcceptingProcessesNext(string, RequestOptionsBase, ServiceCallback<ProcessCollection>)
listAcceptingProcessesNext(string, ServiceCallback<ProcessCollection>)
listConnections(string, string, string, string, PortsListConnectionsOptionalParams)

Returns a collection of connections established via the specified port.

listConnections(string, string, string, string, PortsListConnectionsOptionalParams, ServiceCallback<ConnectionCollection>)
listConnections(string, string, string, string, ServiceCallback<ConnectionCollection>)
listConnectionsNext(string, RequestOptionsBase)

Returns a collection of connections established via the specified port.

listConnectionsNext(string, RequestOptionsBase, ServiceCallback<ConnectionCollection>)
listConnectionsNext(string, ServiceCallback<ConnectionCollection>)

Constructor Details

Ports(ServicemapManagementClientContext)

Create a Ports.

new Ports(client: ServicemapManagementClientContext)

Parameters

client
ServicemapManagementClientContext

Reference to the service client.

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<PortsGetResponse>

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 optional parameters

Returns

Promise<PortsGetResponse>

Promise<Models.PortsGetResponse>

get(string, string, string, string, PortsGetOptionalParams, ServiceCallback<Port>)

function get(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsGetOptionalParams, callback: ServiceCallback<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 optional parameters

callback

ServiceCallback<Port>

The callback

get(string, string, string, string, ServiceCallback<Port>)

function get(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: ServiceCallback<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.

callback

ServiceCallback<Port>

The callback

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<PortsGetLivenessResponse>

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 optional parameters

Returns

Promise<Models.PortsGetLivenessResponse>

getLiveness(string, string, string, string, PortsGetLivenessOptionalParams, ServiceCallback<Liveness>)

function getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsGetLivenessOptionalParams, callback: ServiceCallback<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 optional parameters

callback

ServiceCallback<Liveness>

The callback

getLiveness(string, string, string, string, ServiceCallback<Liveness>)

function getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: ServiceCallback<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.

callback

ServiceCallback<Liveness>

The callback

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): Promise<PortsListAcceptingProcessesResponse>

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 optional parameters

Returns

Promise<Models.PortsListAcceptingProcessesResponse>

listAcceptingProcesses(string, string, string, string, PortsListAcceptingProcessesOptionalParams, ServiceCallback<ProcessCollection>)

function listAcceptingProcesses(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsListAcceptingProcessesOptionalParams, callback: ServiceCallback<ProcessCollection>)

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 optional parameters

callback

ServiceCallback<ProcessCollection>

The callback

listAcceptingProcesses(string, string, string, string, ServiceCallback<ProcessCollection>)

function listAcceptingProcesses(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: ServiceCallback<ProcessCollection>)

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.

callback

ServiceCallback<ProcessCollection>

The callback

listAcceptingProcessesNext(string, RequestOptionsBase)

Returns a collection of processes accepting on the specified port

function listAcceptingProcessesNext(nextPageLink: string, options?: RequestOptionsBase): Promise<PortsListAcceptingProcessesNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.PortsListAcceptingProcessesNextResponse>

listAcceptingProcessesNext(string, RequestOptionsBase, ServiceCallback<ProcessCollection>)

function listAcceptingProcessesNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ProcessCollection>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<ProcessCollection>

The callback

listAcceptingProcessesNext(string, ServiceCallback<ProcessCollection>)

function listAcceptingProcessesNext(nextPageLink: string, callback: ServiceCallback<ProcessCollection>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ProcessCollection>

The callback

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): Promise<PortsListConnectionsResponse>

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 optional parameters

Returns

Promise<Models.PortsListConnectionsResponse>

listConnections(string, string, string, string, PortsListConnectionsOptionalParams, ServiceCallback<ConnectionCollection>)

function listConnections(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsListConnectionsOptionalParams, callback: ServiceCallback<ConnectionCollection>)

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 optional parameters

callback

ServiceCallback<ConnectionCollection>

The callback

listConnections(string, string, string, string, ServiceCallback<ConnectionCollection>)

function listConnections(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: ServiceCallback<ConnectionCollection>)

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.

callback

ServiceCallback<ConnectionCollection>

The callback

listConnectionsNext(string, RequestOptionsBase)

Returns a collection of connections established via the specified port.

function listConnectionsNext(nextPageLink: string, options?: RequestOptionsBase): Promise<PortsListConnectionsNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<Models.PortsListConnectionsNextResponse>

listConnectionsNext(string, RequestOptionsBase, ServiceCallback<ConnectionCollection>)

function listConnectionsNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ConnectionCollection>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<ConnectionCollection>

The callback

listConnectionsNext(string, ServiceCallback<ConnectionCollection>)

function listConnectionsNext(nextPageLink: string, callback: ServiceCallback<ConnectionCollection>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ConnectionCollection>

The callback