Machines | @azure/arm-servicemap

Class representing a Machines.

Hierarchy

Machines

Index

Constructors

constructor

Methods

Constructors

constructor

new Machines(client: ServicemapManagementClientContext): Machines

- Defined in operations/machines.ts:19
Create a Machines.

Parameters
- client: ServicemapManagementClientContext
  
  Reference to the service client.
Returns Machines

Methods

get

get(resourceGroupName: string, workspaceName: string, machineName: string, options?: Models.MachinesGetOptionalParams): Promise<Models.MachinesGetResponse>
get(resourceGroupName: string, workspaceName: string, machineName: string, callback: msRest.ServiceCallback<Machine>): void
get(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesGetOptionalParams, callback: msRest.ServiceCallback<Machine>): void

- Defined in operations/machines.ts:72
Returns the specified 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.
- Optional options: Models.MachinesGetOptionalParams
Returns Promise<Models.MachinesGetResponse>

Promise<Models.MachinesGetResponse>
- Defined in operations/machines.ts:79
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: msRest.ServiceCallback<Machine>
  
  The callback
Returns void
- Defined in operations/machines.ts:87
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: msRest.ServiceCallback<Machine>
  
  The callback
Returns void

getLiveness

getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, options?: Models.MachinesGetLivenessOptionalParams): Promise<Models.MachinesGetLivenessResponse>
getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, callback: msRest.ServiceCallback<Liveness>): void
getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesGetLivenessOptionalParams, callback: msRest.ServiceCallback<Liveness>): void

- Defined in operations/machines.ts:108
Obtains the liveness status of the machine during the specified time interval.

Parameters
- resourceGroupName: string
  
  Resource group name within the specified subscriptionId.
- workspaceName: string
  
  OMS workspace containing the resources of interest.
- machineName: string
  
  Machine resource name.
- Optional options: Models.MachinesGetLivenessOptionalParams
Returns Promise<Models.MachinesGetLivenessResponse>

Promise<Models.MachinesGetLivenessResponse>
- Defined in operations/machines.ts:115
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: msRest.ServiceCallback<Liveness>
  
  The callback
Returns void
- Defined in operations/machines.ts:123
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 optional parameters
- callback: msRest.ServiceCallback<Liveness>
  
  The callback
Returns void

listByWorkspace

listByWorkspace(resourceGroupName: string, workspaceName: string, options?: Models.MachinesListByWorkspaceOptionalParams): Promise<Models.MachinesListByWorkspaceResponse>
listByWorkspace(resourceGroupName: string, workspaceName: string, callback: msRest.ServiceCallback<MachineCollection>): void
listByWorkspace(resourceGroupName: string, workspaceName: string, options: MachinesListByWorkspaceOptionalParams, callback: msRest.ServiceCallback<MachineCollection>): void

- Defined in operations/machines.ts:39
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).

Parameters
- resourceGroupName: string
  
  Resource group name within the specified subscriptionId.
- workspaceName: string
  
  OMS workspace containing the resources of interest.
- Optional options: Models.MachinesListByWorkspaceOptionalParams
Returns Promise<Models.MachinesListByWorkspaceResponse>

Promise<Models.MachinesListByWorkspaceResponse>
- Defined in operations/machines.ts:45
Parameters
- resourceGroupName: string
  
  Resource group name within the specified subscriptionId.
- workspaceName: string
  
  OMS workspace containing the resources of interest.
- callback: msRest.ServiceCallback<MachineCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:52
Parameters
- resourceGroupName: string
  
  Resource group name within the specified subscriptionId.
- workspaceName: string
  
  OMS workspace containing the resources of interest.
- options: MachinesListByWorkspaceOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<MachineCollection>
  
  The callback
Returns void

listByWorkspaceNext

listByWorkspaceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.MachinesListByWorkspaceNextResponse>
listByWorkspaceNext(nextPageLink: string, callback: msRest.ServiceCallback<MachineCollection>): void
listByWorkspaceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MachineCollection>): void

- Defined in operations/machines.ts:294
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).

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MachinesListByWorkspaceNextResponse>

Promise<Models.MachinesListByWorkspaceNextResponse>
- Defined in operations/machines.ts:299
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<MachineCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:305
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<MachineCollection>
  
  The callback
Returns void

listConnections

listConnections(resourceGroupName: string, workspaceName: string, machineName: string, options?: Models.MachinesListConnectionsOptionalParams): Promise<Models.MachinesListConnectionsResponse>
listConnections(resourceGroupName: string, workspaceName: string, machineName: string, callback: msRest.ServiceCallback<ConnectionCollection>): void
listConnections(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListConnectionsOptionalParams, callback: msRest.ServiceCallback<ConnectionCollection>): void

- Defined in operations/machines.ts:144
Returns a collection of connections terminating or originating at the specified 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.
- Optional options: Models.MachinesListConnectionsOptionalParams
Returns Promise<Models.MachinesListConnectionsResponse>

Promise<Models.MachinesListConnectionsResponse>
- Defined in operations/machines.ts:151
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: msRest.ServiceCallback<ConnectionCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:159
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 optional parameters
- callback: msRest.ServiceCallback<ConnectionCollection>
  
  The callback
Returns void

listConnectionsNext

listConnectionsNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.MachinesListConnectionsNextResponse>
listConnectionsNext(nextPageLink: string, callback: msRest.ServiceCallback<ConnectionCollection>): void
listConnectionsNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionCollection>): void

- Defined in operations/machines.ts:322
Returns a collection of connections terminating or originating at the specified machine

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MachinesListConnectionsNextResponse>

Promise<Models.MachinesListConnectionsNextResponse>
- Defined in operations/machines.ts:327
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ConnectionCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:333
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ConnectionCollection>
  
  The callback
Returns void

listMachineGroupMembership

listMachineGroupMembership(resourceGroupName: string, workspaceName: string, machineName: string, options?: Models.MachinesListMachineGroupMembershipOptionalParams): Promise<Models.MachinesListMachineGroupMembershipResponse>
listMachineGroupMembership(resourceGroupName: string, workspaceName: string, machineName: string, callback: msRest.ServiceCallback<MachineGroupCollection>): void
listMachineGroupMembership(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListMachineGroupMembershipOptionalParams, callback: msRest.ServiceCallback<MachineGroupCollection>): void

- Defined in operations/machines.ts:257
Returns a collection of machine groups this machine belongs to during the specified time interval.

Parameters
- resourceGroupName: string
  
  Resource group name within the specified subscriptionId.
- workspaceName: string
  
  OMS workspace containing the resources of interest.
- machineName: string
  
  Machine resource name.
- Optional options: Models.MachinesListMachineGroupMembershipOptionalParams
Returns Promise<Models.MachinesListMachineGroupMembershipResponse>

Promise<Models.MachinesListMachineGroupMembershipResponse>
- Defined in operations/machines.ts:264
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: msRest.ServiceCallback<MachineGroupCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:272
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 optional parameters
- callback: msRest.ServiceCallback<MachineGroupCollection>
  
  The callback
Returns void

listMachineGroupMembershipNext

listMachineGroupMembershipNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.MachinesListMachineGroupMembershipNextResponse>
listMachineGroupMembershipNext(nextPageLink: string, callback: msRest.ServiceCallback<MachineGroupCollection>): void
listMachineGroupMembershipNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<MachineGroupCollection>): void

- Defined in operations/machines.ts:411
Returns a collection of machine groups this machine belongs to during the specified time interval.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MachinesListMachineGroupMembershipNextResponse>

Promise<Models.MachinesListMachineGroupMembershipNextResponse>
- Defined in operations/machines.ts:416
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<MachineGroupCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:422
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<MachineGroupCollection>
  
  The callback
Returns void

listPorts

listPorts(resourceGroupName: string, workspaceName: string, machineName: string, options?: Models.MachinesListPortsOptionalParams): Promise<Models.MachinesListPortsResponse>
listPorts(resourceGroupName: string, workspaceName: string, machineName: string, callback: msRest.ServiceCallback<PortCollection>): void
listPorts(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListPortsOptionalParams, callback: msRest.ServiceCallback<PortCollection>): void

- Defined in operations/machines.ts:220
Returns a collection of live ports on the specified machine during the specified time interval.

Parameters
- resourceGroupName: string
  
  Resource group name within the specified subscriptionId.
- workspaceName: string
  
  OMS workspace containing the resources of interest.
- machineName: string
  
  Machine resource name.
- Optional options: Models.MachinesListPortsOptionalParams
Returns Promise<Models.MachinesListPortsResponse>

Promise<Models.MachinesListPortsResponse>
- Defined in operations/machines.ts:227
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: msRest.ServiceCallback<PortCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:235
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: msRest.ServiceCallback<PortCollection>
  
  The callback
Returns void

listPortsNext

listPortsNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.MachinesListPortsNextResponse>
listPortsNext(nextPageLink: string, callback: msRest.ServiceCallback<PortCollection>): void
listPortsNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PortCollection>): void

- Defined in operations/machines.ts:382
Returns a collection of live ports on the specified machine during the specified time interval.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MachinesListPortsNextResponse>

Promise<Models.MachinesListPortsNextResponse>
- Defined in operations/machines.ts:387
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<PortCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:393
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<PortCollection>
  
  The callback
Returns void

listProcesses

listProcesses(resourceGroupName: string, workspaceName: string, machineName: string, options?: Models.MachinesListProcessesOptionalParams): Promise<Models.MachinesListProcessesResponse>
listProcesses(resourceGroupName: string, workspaceName: string, machineName: string, callback: msRest.ServiceCallback<ProcessCollection>): void
listProcesses(resourceGroupName: string, workspaceName: string, machineName: string, options: MachinesListProcessesOptionalParams, callback: msRest.ServiceCallback<ProcessCollection>): void

- Defined in operations/machines.ts:184
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).

Parameters
- resourceGroupName: string
  
  Resource group name within the specified subscriptionId.
- workspaceName: string
  
  OMS workspace containing the resources of interest.
- machineName: string
  
  Machine resource name.
- Optional options: Models.MachinesListProcessesOptionalParams
Returns Promise<Models.MachinesListProcessesResponse>

Promise<Models.MachinesListProcessesResponse>
- Defined in operations/machines.ts:191
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: msRest.ServiceCallback<ProcessCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:199
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 optional parameters
- callback: msRest.ServiceCallback<ProcessCollection>
  
  The callback
Returns void

listProcessesNext

listProcessesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.MachinesListProcessesNextResponse>
listProcessesNext(nextPageLink: string, callback: msRest.ServiceCallback<ProcessCollection>): void
listProcessesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProcessCollection>): void

- Defined in operations/machines.ts:354
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).

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MachinesListProcessesNextResponse>

Promise<Models.MachinesListProcessesNextResponse>
- Defined in operations/machines.ts:359
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ProcessCollection>
  
  The callback
Returns void
- Defined in operations/machines.ts:365
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ProcessCollection>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ServicemapManagementClientContext

Returns Machines

Methods

get

Parameters

resourceGroupName: string

workspaceName: string

machineName: string

Optional options: Models.MachinesGetOptionalParams

Returns Promise<Models.MachinesGetResponse>

Parameters

resourceGroupName: string

workspaceName: string

machineName: string

callback: msRest.ServiceCallback<Machine>

Returns void

Parameters

resourceGroupName: string

workspaceName: string

machineName: string

options: MachinesGetOptionalParams

callback: msRest.ServiceCallback<Machine>

Returns void

getLiveness

Parameters

resourceGroupName: string

workspaceName: string

machineName: string

Optional options: Models.MachinesGetLivenessOptionalParams

Returns Promise<Models.MachinesGetLivenessResponse>

Parameters

resourceGroupName: string

workspaceName: string

machineName: string

callback: msRest.ServiceCallback<Liveness>

Returns void

Parameters

resourceGroupName: string

workspaceName: string

machineName: string

options: MachinesGetLivenessOptionalParams

callback: msRest.ServiceCallback<Liveness>

Returns void

listByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

Optional options: Models.MachinesListByWorkspaceOptionalParams

Returns Promise<Models.MachinesListByWorkspaceResponse>

Parameters

resourceGroupName: string

workspaceName: string

callback: msRest.ServiceCallback<MachineCollection>

Returns void

Parameters

resourceGroupName: string

workspaceName: string

options: MachinesListByWorkspaceOptionalParams

callback: msRest.ServiceCallback<MachineCollection>

Returns void

listByWorkspaceNext

Parameters

nextPageLink: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MachinesListByWorkspaceNextResponse>

Parameters

nextPageLink: string

callback: msRest.ServiceCallback<MachineCollection>

Returns void

Parameters

nextPageLink: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<MachineCollection>