Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ports

Package version

Class representing a Ports.

Hierarchy

  • Ports

Index

Constructors

Methods

Constructors

constructor

Methods

get

  • get(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: Models.PortsGetOptionalParams): Promise<Models.PortsGetResponse>
  • get(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: msRest.ServiceCallback<Port>): void
  • get(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsGetOptionalParams, callback: msRest.ServiceCallback<Port>): void

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

    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.

    • Optional options: Models.PortsGetOptionalParams

    Returns Promise<Models.PortsGetResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<Port>

      The callback

    Returns void

  • 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: msRest.ServiceCallback<Port>

      The callback

    Returns void

getLiveness

  • getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: Models.PortsGetLivenessOptionalParams): Promise<Models.PortsGetLivenessResponse>
  • getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: msRest.ServiceCallback<Liveness>): void
  • getLiveness(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsGetLivenessOptionalParams, callback: msRest.ServiceCallback<Liveness>): void

  • Obtains the liveness status of the port 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.

    • portName: string

      Port resource name.

    • Optional options: Models.PortsGetLivenessOptionalParams

    Returns Promise<Models.PortsGetLivenessResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<Liveness>

      The callback

    Returns void

  • 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: msRest.ServiceCallback<Liveness>

      The callback

    Returns void

listAcceptingProcesses

  • listAcceptingProcesses(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: Models.PortsListAcceptingProcessesOptionalParams): Promise<Models.PortsListAcceptingProcessesResponse>
  • listAcceptingProcesses(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: msRest.ServiceCallback<ProcessCollection>): void
  • listAcceptingProcesses(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsListAcceptingProcessesOptionalParams, callback: msRest.ServiceCallback<ProcessCollection>): void

  • Returns a collection of processes accepting on the specified 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.

    • Optional options: Models.PortsListAcceptingProcessesOptionalParams

    Returns Promise<Models.PortsListAcceptingProcessesResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<ProcessCollection>

      The callback

    Returns void

  • 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: msRest.ServiceCallback<ProcessCollection>

      The callback

    Returns void

listAcceptingProcessesNext

  • listAcceptingProcessesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.PortsListAcceptingProcessesNextResponse>
  • listAcceptingProcessesNext(nextPageLink: string, callback: msRest.ServiceCallback<ProcessCollection>): void
  • listAcceptingProcessesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProcessCollection>): void

  • Returns a collection of processes accepting on the specified port

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PortsListAcceptingProcessesNextResponse>

    Promise<Models.PortsListAcceptingProcessesNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ProcessCollection>

      The callback

    Returns void

  • 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

listConnections

  • listConnections(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options?: Models.PortsListConnectionsOptionalParams): Promise<Models.PortsListConnectionsResponse>
  • listConnections(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, callback: msRest.ServiceCallback<ConnectionCollection>): void
  • listConnections(resourceGroupName: string, workspaceName: string, machineName: string, portName: string, options: PortsListConnectionsOptionalParams, callback: msRest.ServiceCallback<ConnectionCollection>): void

  • Returns a collection of connections established via the specified 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.

    • Optional options: Models.PortsListConnectionsOptionalParams

    Returns Promise<Models.PortsListConnectionsResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<ConnectionCollection>

      The callback

    Returns void

  • 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: msRest.ServiceCallback<ConnectionCollection>

      The callback

    Returns void

listConnectionsNext

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

  • Returns a collection of connections established via the specified port.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PortsListConnectionsNextResponse>

    Promise<Models.PortsListConnectionsNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ConnectionCollection>

      The callback

    Returns void

  • 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

Generated using TypeDoc