Machines class
Class representing a Machines.
Constructors
Machines(Servicemap |
Create a Machines. |
Methods
Constructor Details
Machines(ServicemapManagementClientContext)
Create a Machines.
new Machines(client: ServicemapManagementClientContext)
Parameters
Reference to the service client.
Method Details
get(string, string, string, MachinesGetOptionalParams)
Returns the specified machine.
function get(resourceGroupName: string, workspaceName: string, machineName: string, options?: MachinesGetOptionalParams): Promise<MachinesGetResponse>
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 optional parameters
Returns
Promise<MachinesGetResponse>
Promise<Models.MachinesGetResponse>
get(string, string, string, MachinesGetOptionalParams, ServiceCallback<Machine>)
function get(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesGetOptionalParams, callback: ServiceCallback<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 optional parameters
- callback
The callback
get(string, string, string, ServiceCallback<Machine>)
function get(resourceGroupName: string, workspaceName: string, machineName: string, callback: ServiceCallback<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.
- callback
The callback
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<MachinesGetLivenessResponse>
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- machineName
-
string
Machine resource name.
The optional parameters
Returns
Promise<MachinesGetLivenessResponse>
Promise<Models.MachinesGetLivenessResponse>
getLiveness(string, string, string, MachinesGetLivenessOptionalParams, ServiceCallback<Liveness>)
function getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesGetLivenessOptionalParams, 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.
The optional parameters
- callback
The callback
getLiveness(string, string, string, ServiceCallback<Liveness>)
function getLiveness(resourceGroupName: string, workspaceName: string, machineName: 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.
- callback
The callback
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): Promise<MachinesListByWorkspaceResponse>
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
The optional parameters
Returns
Promise<MachinesListByWorkspaceResponse>
Promise<Models.MachinesListByWorkspaceResponse>
listByWorkspace(string, string, MachinesListByWorkspaceOptionalParams, ServiceCallback<MachineCollection>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, options: MachinesListByWorkspaceOptionalParams, callback: ServiceCallback<MachineCollection>)
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
The optional parameters
- callback
The callback
listByWorkspace(string, string, ServiceCallback<MachineCollection>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, callback: ServiceCallback<MachineCollection>)
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- callback
The callback
listByWorkspaceNext(string, RequestOptionsBase)
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 listByWorkspaceNext(nextPageLink: string, options?: RequestOptionsBase): Promise<MachinesListByWorkspaceNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<MachinesListByWorkspaceNextResponse>
Promise<Models.MachinesListByWorkspaceNextResponse>
listByWorkspaceNext(string, RequestOptionsBase, ServiceCallback<MachineCollection>)
function listByWorkspaceNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<MachineCollection>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByWorkspaceNext(string, ServiceCallback<MachineCollection>)
function listByWorkspaceNext(nextPageLink: string, callback: ServiceCallback<MachineCollection>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
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): Promise<MachinesListConnectionsResponse>
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- machineName
-
string
Machine resource name.
The optional parameters
Returns
Promise<MachinesListConnectionsResponse>
Promise<Models.MachinesListConnectionsResponse>
listConnections(string, string, string, MachinesListConnectionsOptionalParams, ServiceCallback<ConnectionCollection>)
function listConnections(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListConnectionsOptionalParams, 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.
The optional parameters
- callback
The callback
listConnections(string, string, string, ServiceCallback<ConnectionCollection>)
function listConnections(resourceGroupName: string, workspaceName: string, machineName: 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.
- callback
The callback
listConnectionsNext(string, RequestOptionsBase)
Returns a collection of connections terminating or originating at the specified machine
function listConnectionsNext(nextPageLink: string, options?: RequestOptionsBase): Promise<MachinesListConnectionsNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<MachinesListConnectionsNextResponse>
Promise<Models.MachinesListConnectionsNextResponse>
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
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
The callback
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): Promise<MachinesListMachineGroupMembershipResponse>
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- machineName
-
string
Machine resource name.
The optional parameters
Returns
Promise<Models.MachinesListMachineGroupMembershipResponse>
listMachineGroupMembership(string, string, string, MachinesListMachineGroupMembershipOptionalParams, ServiceCallback<MachineGroupCollection>)
function listMachineGroupMembership(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListMachineGroupMembershipOptionalParams, callback: ServiceCallback<MachineGroupCollection>)
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- machineName
-
string
Machine resource name.
The optional parameters
- callback
The callback
listMachineGroupMembership(string, string, string, ServiceCallback<MachineGroupCollection>)
function listMachineGroupMembership(resourceGroupName: string, workspaceName: string, machineName: string, callback: ServiceCallback<MachineGroupCollection>)
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- machineName
-
string
Machine resource name.
- callback
The callback
listMachineGroupMembershipNext(string, RequestOptionsBase)
Returns a collection of machine groups this machine belongs to during the specified time interval.
function listMachineGroupMembershipNext(nextPageLink: string, options?: RequestOptionsBase): Promise<MachinesListMachineGroupMembershipNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.MachinesListMachineGroupMembershipNextResponse>
listMachineGroupMembershipNext(string, RequestOptionsBase, ServiceCallback<MachineGroupCollection>)
function listMachineGroupMembershipNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<MachineGroupCollection>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listMachineGroupMembershipNext(string, ServiceCallback<MachineGroupCollection>)
function listMachineGroupMembershipNext(nextPageLink: string, callback: ServiceCallback<MachineGroupCollection>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
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): Promise<MachinesListPortsResponse>
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 optional parameters
Returns
Promise<MachinesListPortsResponse>
Promise<Models.MachinesListPortsResponse>
listPorts(string, string, string, MachinesListPortsOptionalParams, ServiceCallback<PortCollection>)
function listPorts(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListPortsOptionalParams, callback: ServiceCallback<PortCollection>)
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 optional parameters
- callback
The callback
listPorts(string, string, string, ServiceCallback<PortCollection>)
function listPorts(resourceGroupName: string, workspaceName: string, machineName: string, callback: ServiceCallback<PortCollection>)
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- machineName
-
string
Machine resource name.
- callback
The callback
listPortsNext(string, RequestOptionsBase)
Returns a collection of live ports on the specified machine during the specified time interval.
function listPortsNext(nextPageLink: string, options?: RequestOptionsBase): Promise<MachinesListPortsNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<MachinesListPortsNextResponse>
Promise<Models.MachinesListPortsNextResponse>
listPortsNext(string, RequestOptionsBase, ServiceCallback<PortCollection>)
function listPortsNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<PortCollection>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listPortsNext(string, ServiceCallback<PortCollection>)
function listPortsNext(nextPageLink: string, callback: ServiceCallback<PortCollection>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
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): Promise<MachinesListProcessesResponse>
Parameters
- resourceGroupName
-
string
Resource group name within the specified subscriptionId.
- workspaceName
-
string
OMS workspace containing the resources of interest.
- machineName
-
string
Machine resource name.
The optional parameters
Returns
Promise<MachinesListProcessesResponse>
Promise<Models.MachinesListProcessesResponse>
listProcesses(string, string, string, MachinesListProcessesOptionalParams, ServiceCallback<ProcessCollection>)
function listProcesses(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListProcessesOptionalParams, 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.
The optional parameters
- callback
The callback
listProcesses(string, string, string, ServiceCallback<ProcessCollection>)
function listProcesses(resourceGroupName: string, workspaceName: string, machineName: 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.
- callback
The callback
listProcessesNext(string, RequestOptionsBase)
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 listProcessesNext(nextPageLink: string, options?: RequestOptionsBase): Promise<MachinesListProcessesNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<MachinesListProcessesNextResponse>
Promise<Models.MachinesListProcessesNextResponse>
listProcessesNext(string, RequestOptionsBase, ServiceCallback<ProcessCollection>)
function listProcessesNext(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
The callback
listProcessesNext(string, ServiceCallback<ProcessCollection>)
function listProcessesNext(nextPageLink: string, callback: ServiceCallback<ProcessCollection>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback