Machines interface

Interface representing a Machines.

Methods

get(string, string, string, MachinesGetOptionalParams)

Returns the specified machine.

getLiveness(string, string, string, MachinesGetLivenessOptionalParams)

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

listByWorkspace(string, string, MachinesListByWorkspaceOptionalParams)

Returns a collection of machines matching the specified conditions. The returned collection represents either machines that are active/live during the specified interval of time (live=true and startTime/endTime are specified) or that are known to have existed at or some time prior to the specified point in time (live=false and timestamp is specified).

listConnections(string, string, string, MachinesListConnectionsOptionalParams)

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

listMachineGroupMembership(string, string, string, MachinesListMachineGroupMembershipOptionalParams)

Returns a collection of machine groups this machine belongs to during the specified time interval.

listPorts(string, string, string, MachinesListPortsOptionalParams)

Returns a collection of live ports on the specified machine during the specified time interval.

listProcesses(string, string, string, MachinesListProcessesOptionalParams)

Returns a collection of processes on the specified machine matching the specified conditions. The returned collection represents either processes that are active/live during the specified interval of time (live=true and startTime/endTime are specified) or that are known to have existed at or some time prior to the specified point in time (live=false and timestamp is specified).

Method Details

get(string, string, string, MachinesGetOptionalParams)

Returns the specified machine.

function get(resourceGroupName: string, workspaceName: string, machineName: string, options?: MachinesGetOptionalParams): Promise<Machine>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineName

string

Machine resource name.

options
MachinesGetOptionalParams

The options parameters.

Returns

Promise<Machine>

getLiveness(string, string, string, MachinesGetLivenessOptionalParams)

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

function getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, options?: MachinesGetLivenessOptionalParams): 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.

options
MachinesGetLivenessOptionalParams

The options parameters.

Returns

Promise<Liveness>

listByWorkspace(string, string, MachinesListByWorkspaceOptionalParams)

Returns a collection of machines matching the specified conditions. The returned collection represents either machines that are active/live during the specified interval of time (live=true and startTime/endTime are specified) or that are known to have existed at or some time prior to the specified point in time (live=false and timestamp is specified).

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: MachinesListByWorkspaceOptionalParams): PagedAsyncIterableIterator<Machine, Machine[], PageSettings>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

options
MachinesListByWorkspaceOptionalParams

The options parameters.

Returns

listConnections(string, string, string, MachinesListConnectionsOptionalParams)

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

function listConnections(resourceGroupName: string, workspaceName: string, machineName: string, options?: MachinesListConnectionsOptionalParams): 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.

options
MachinesListConnectionsOptionalParams

The options parameters.

Returns

listMachineGroupMembership(string, string, string, MachinesListMachineGroupMembershipOptionalParams)

Returns a collection of machine groups this machine belongs to during the specified time interval.

function listMachineGroupMembership(resourceGroupName: string, workspaceName: string, machineName: string, options?: MachinesListMachineGroupMembershipOptionalParams): PagedAsyncIterableIterator<MachineGroup, MachineGroup[], 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.

options
MachinesListMachineGroupMembershipOptionalParams

The options parameters.

Returns

listPorts(string, string, string, MachinesListPortsOptionalParams)

Returns a collection of live ports on the specified machine during the specified time interval.

function listPorts(resourceGroupName: string, workspaceName: string, machineName: string, options?: MachinesListPortsOptionalParams): PagedAsyncIterableIterator<Port, Port[], 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.

options
MachinesListPortsOptionalParams

The options parameters.

Returns

listProcesses(string, string, string, MachinesListProcessesOptionalParams)

Returns a collection of processes on the specified machine matching the specified conditions. The returned collection represents either processes that are active/live during the specified interval of time (live=true and startTime/endTime are specified) or that are known to have existed at or some time prior to the specified point in time (live=false and timestamp is specified).

function listProcesses(resourceGroupName: string, workspaceName: string, machineName: string, options?: MachinesListProcessesOptionalParams): 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.

options
MachinesListProcessesOptionalParams

The options parameters.

Returns